1 //! OS-based thread local storage
3 //! This module provides an implementation of OS-based thread local storage,
4 //! using the native OS-provided facilities (think `TlsAlloc` or
5 //! `pthread_setspecific`). The interface of this differs from the other types
6 //! of thread-local-storage provided in this crate in that OS-based TLS can only
7 //! get/set pointer-sized data, possibly with an associated destructor.
9 //! This module also provides two flavors of TLS. One is intended for static
10 //! initialization, and does not contain a `Drop` implementation to deallocate
11 //! the OS-TLS key. The other is a type which does implement `Drop` and hence
12 //! has a safe interface.
16 //! This module should likely not be used directly unless other primitives are
17 //! being built on. Types such as `thread_local::spawn::Key` are likely much
18 //! more useful in practice than this OS-based version which likely requires
19 //! unsafe code to interoperate with.
23 //! Using a dynamically allocated TLS key. Note that this key can be shared
24 //! among many threads via an `Arc`.
26 //! ```ignore (cannot-doctest-private-modules)
27 //! let key = Key::new(None);
28 //! assert!(key.get().is_null());
29 //! key.set(1 as *mut u8);
30 //! assert!(!key.get().is_null());
32 //! drop(key); // deallocate this TLS slot.
35 //! Sometimes a statically allocated key is either required or easier to work
38 //! ```ignore (cannot-doctest-private-modules)
39 //! static KEY: StaticKey = INIT;
42 //! assert!(KEY.get().is_null());
43 //! KEY.set(1 as *mut u8);
47 #![allow(non_camel_case_types)]
48 #![unstable(feature = "thread_local_internals", issue = "none")]
54 use crate::sync
::atomic
::{self, AtomicUsize, Ordering}
;
55 use crate::sys
::thread_local_key
as imp
;
56 use crate::sys_common
::mutex
::StaticMutex
;
58 /// A type for TLS keys that are statically allocated.
60 /// This type is entirely `unsafe` to use as it does not protect against
61 /// use-after-deallocation or use-during-deallocation.
63 /// The actual OS-TLS key is lazily allocated when this is used for the first
64 /// time. The key is also deallocated when the Rust runtime exits or `destroy`
65 /// is called, whichever comes first.
69 /// ```ignore (cannot-doctest-private-modules)
70 /// use tls::os::{StaticKey, INIT};
72 /// static KEY: StaticKey = INIT;
75 /// assert!(KEY.get().is_null());
76 /// KEY.set(1 as *mut u8);
79 pub struct StaticKey
{
80 /// Inner static TLS key (internals).
82 /// Destructor for the TLS value.
84 /// See `Key::new` for information about when the destructor runs and how
86 dtor
: Option
<unsafe extern "C" fn(*mut u8)>,
89 /// A type for a safely managed OS-based TLS slot.
91 /// This type allocates an OS TLS key when it is initialized and will deallocate
92 /// the key when it falls out of scope. When compared with `StaticKey`, this
93 /// type is entirely safe to use.
95 /// Implementations will likely, however, contain unsafe code as this type only
96 /// operates on `*mut u8`, a raw pointer.
100 /// ```ignore (cannot-doctest-private-modules)
101 /// use tls::os::Key;
103 /// let key = Key::new(None);
104 /// assert!(key.get().is_null());
105 /// key.set(1 as *mut u8);
106 /// assert!(!key.get().is_null());
108 /// drop(key); // deallocate this TLS slot.
114 /// Constant initialization value for static TLS keys.
116 /// This value specifies no destructor by default.
117 pub const INIT
: StaticKey
= StaticKey
::new(None
);
120 #[rustc_const_unstable(feature = "thread_local_internals", issue = "none")]
121 pub const fn new(dtor
: Option
<unsafe extern "C" fn(*mut u8)>) -> StaticKey
{
122 StaticKey { key: atomic::AtomicUsize::new(0), dtor }
125 /// Gets the value associated with this TLS key
127 /// This will lazily allocate a TLS key from the OS if one has not already
130 pub unsafe fn get(&self) -> *mut u8 {
134 /// Sets this TLS key to a new value.
136 /// This will lazily allocate a TLS key from the OS if one has not already
139 pub unsafe fn set(&self, val
: *mut u8) {
140 imp
::set(self.key(), val
)
144 unsafe fn key(&self) -> imp
::Key
{
145 match self.key
.load(Ordering
::Relaxed
) {
146 0 => self.lazy_init() as imp
::Key
,
151 unsafe fn lazy_init(&self) -> usize {
152 // Currently the Windows implementation of TLS is pretty hairy, and
153 // it greatly simplifies creation if we just synchronize everything.
155 // Additionally a 0-index of a tls key hasn't been seen on windows, so
156 // we just simplify the whole branch.
157 if imp
::requires_synchronized_create() {
158 // We never call `INIT_LOCK.init()`, so it is UB to attempt to
159 // acquire this mutex reentrantly!
160 static INIT_LOCK
: StaticMutex
= StaticMutex
::new();
161 let _guard
= INIT_LOCK
.lock();
162 let mut key
= self.key
.load(Ordering
::SeqCst
);
164 key
= imp
::create(self.dtor
) as usize;
165 self.key
.store(key
, Ordering
::SeqCst
);
171 // POSIX allows the key created here to be 0, but the compare_exchange
172 // below relies on using 0 as a sentinel value to check who won the
173 // race to set the shared TLS key. As far as I know, there is no
174 // guaranteed value that cannot be returned as a posix_key_create key,
175 // so there is no value we can initialize the inner key with to
176 // prove that it has not yet been set. As such, we'll continue using a
177 // value of 0, but with some gyrations to make sure we have a non-0
178 // value returned from the creation routine.
179 // FIXME: this is clearly a hack, and should be cleaned up.
180 let key1
= imp
::create(self.dtor
);
181 let key
= if key1
!= 0 {
184 let key2
= imp
::create(self.dtor
);
189 match self.key
.compare_exchange(0, key
as usize, Ordering
::SeqCst
, Ordering
::SeqCst
) {
190 // The CAS succeeded, so we've created the actual key
191 Ok(_
) => key
as usize,
192 // If someone beat us to the punch, use their key instead
202 /// Creates a new managed OS TLS key.
204 /// This key will be deallocated when the key falls out of scope.
206 /// The argument provided is an optionally-specified destructor for the
207 /// value of this TLS key. When a thread exits and the value for this key
208 /// is non-null the destructor will be invoked. The TLS value will be reset
209 /// to null before the destructor is invoked.
211 /// Note that the destructor will not be run when the `Key` goes out of
214 pub fn new(dtor
: Option
<unsafe extern "C" fn(*mut u8)>) -> Key
{
215 Key { key: unsafe { imp::create(dtor) }
}
218 /// See StaticKey::get
220 pub fn get(&self) -> *mut u8 {
221 unsafe { imp::get(self.key) }
224 /// See StaticKey::set
226 pub fn set(&self, val
: *mut u8) {
227 unsafe { imp::set(self.key, val) }
233 // Right now Windows doesn't support TLS key destruction, but this also
234 // isn't used anywhere other than tests, so just leak the TLS key.
235 // unsafe { imp::destroy(self.key) }