1 // Copyright 2014-2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! Thread local storage
13 #![unstable(feature = "thread_local_internals", issue = "0")]
19 /// A thread local storage key which owns its contents.
21 /// This key uses the fastest possible implementation available to it for the
22 /// target platform. It is instantiated with the [`thread_local!`] macro and the
23 /// primary method is the [`with`] method.
25 /// The [`with`] method yields a reference to the contained value which cannot be
26 /// sent across threads or escape the given closure.
28 /// # Initialization and Destruction
30 /// Initialization is dynamically performed on the first call to [`with`]
31 /// within a thread, and values that implement [`Drop`] get destructed when a
32 /// thread exits. Some caveats apply, which are explained below.
37 /// use std::cell::RefCell;
40 /// thread_local!(static FOO: RefCell<u32> = RefCell::new(1));
43 /// assert_eq!(*f.borrow(), 1);
44 /// *f.borrow_mut() = 2;
47 /// // each thread starts out with the initial value of 1
48 /// thread::spawn(move|| {
50 /// assert_eq!(*f.borrow(), 1);
51 /// *f.borrow_mut() = 3;
55 /// // we retain our original value of 2 despite the child thread
57 /// assert_eq!(*f.borrow(), 2);
61 /// # Platform-specific behavior
63 /// Note that a "best effort" is made to ensure that destructors for types
64 /// stored in thread local storage are run, but not all platforms can guarantee
65 /// that destructors will be run for all types in thread local storage. For
66 /// example, there are a number of known caveats where destructors are not run:
68 /// 1. On Unix systems when pthread-based TLS is being used, destructors will
69 /// not be run for TLS values on the main thread when it exits. Note that the
70 /// application will exit immediately after the main thread exits as well.
71 /// 2. On all platforms it's possible for TLS to re-initialize other TLS slots
72 /// during destruction. Some platforms ensure that this cannot happen
73 /// infinitely by preventing re-initialization of any slot that has been
74 /// destroyed, but not all platforms have this guard. Those platforms that do
75 /// not guard typically have a synthetic limit after which point no more
76 /// destructors are run.
77 /// 3. On macOS, initializing TLS during destruction of other TLS slots can
78 /// sometimes cancel *all* destructors for the current thread, whether or not
79 /// the slots have already had their destructors run or not.
81 /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
82 /// [`thread_local!`]: ../../std/macro.thread_local.html
83 /// [`Drop`]: ../../std/ops/trait.Drop.html
84 #[stable(feature = "rust1", since = "1.0.0")]
85 pub struct LocalKey<T: 'static> {
86 // This outer `LocalKey<T>` type is what's going to be stored in statics,
87 // but actual data inside will sometimes be tagged with #[thread_local].
88 // It's not valid for a true static to reference a #[thread_local] static,
89 // so we get around that by exposing an accessor through a layer of function
90 // indirection (this thunk).
92 // Note that the thunk is itself unsafe because the returned lifetime of the
93 // slot where data lives, `'static`, is not actually valid. The lifetime
94 // here is actually `'thread`!
96 // Although this is an extra layer of indirection, it should in theory be
97 // trivially devirtualizable by LLVM because the value of `inner` never
98 // changes and the constant should be readonly within a crate. This mainly
99 // only runs into problems when TLS statics are exported across crates.
100 inner: fn() -> Option<&'static UnsafeCell<Option<T>>>,
102 // initialization routine to invoke to create a value
106 #[stable(feature = "std_debug", since = "1.16.0")]
107 impl<T: 'static> fmt::Debug for LocalKey<T> {
108 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
109 f.pad("LocalKey { .. }")
113 /// Declare a new thread local storage key of type [`std::thread::LocalKey`].
117 /// The macro wraps any number of static declarations and makes them thread local.
118 /// Publicity and attributes for each static are allowed. Example:
121 /// use std::cell::RefCell;
123 /// pub static FOO: RefCell<u32> = RefCell::new(1);
126 /// static BAR: RefCell<f32> = RefCell::new(1.0);
131 /// See [LocalKey documentation][`std::thread::LocalKey`] for more
134 /// [`std::thread::LocalKey`]: ../std/thread/struct.LocalKey.html
136 #[stable(feature = "rust1", since = "1.0.0")]
137 #[allow_internal_unstable]
138 macro_rules! thread_local {
139 // empty (base case for the recursion)
142 // process multiple declarations
143 ($(#[$attr:meta])* $vis:vis static $name:ident: $t:ty = $init:expr; $($rest:tt)*) => (
144 __thread_local_inner!($(#[$attr])* $vis $name, $t, $init);
145 thread_local!($($rest)*);
148 // handle a single declaration
149 ($(#[$attr:meta])* $vis:vis static $name:ident: $t:ty = $init:expr) => (
150 __thread_local_inner!($(#[$attr])* $vis $name, $t, $init);
155 #[unstable(feature = "thread_local_internals",
156 reason = "should not be necessary",
159 #[allow_internal_unstable]
160 macro_rules! __thread_local_inner {
161 ($(#[$attr:meta])* $vis:vis $name:ident, $t:ty, $init:expr) => {
162 $(#[$attr])* $vis static $name: $crate::thread::LocalKey<$t> = {
163 fn __init() -> $t { $init }
165 fn __getit() -> $crate::option::Option<
166 &'static $crate::cell::UnsafeCell<
167 $crate::option::Option<$t>>>
170 #[cfg(target_thread_local)]
171 static __KEY: $crate::thread::__FastLocalKeyInner<$t> =
172 $crate::thread::__FastLocalKeyInner::new();
174 #[cfg(not(target_thread_local))]
175 static __KEY: $crate::thread::__OsLocalKeyInner<$t> =
176 $crate::thread::__OsLocalKeyInner::new();
181 $crate::thread::LocalKey::new(__getit, __init)
186 /// Indicator of the state of a thread local storage key.
187 #[unstable(feature = "thread_local_state",
188 reason = "state querying was recently added",
190 #[derive(Debug, Eq, PartialEq, Copy, Clone)]
191 pub enum LocalKeyState {
192 /// All keys are in this state whenever a thread starts. Keys will
193 /// transition to the `Valid` state once the first call to [`with`] happens
194 /// and the initialization expression succeeds.
196 /// Keys in the `Uninitialized` state will yield a reference to the closure
197 /// passed to [`with`] so long as the initialization routine does not panic.
199 /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
202 /// Once a key has been accessed successfully, it will enter the `Valid`
203 /// state. Keys in the `Valid` state will remain so until the thread exits,
204 /// at which point the destructor will be run and the key will enter the
205 /// `Destroyed` state.
207 /// Keys in the `Valid` state will be guaranteed to yield a reference to the
208 /// closure passed to [`with`].
210 /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
213 /// When a thread exits, the destructors for keys will be run (if
214 /// necessary). While a destructor is running, and possibly after a
215 /// destructor has run, a key is in the `Destroyed` state.
217 /// Keys in the `Destroyed` states will trigger a panic when accessed via
220 /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
224 /// An error returned by [`LocalKey::try_with`](struct.LocalKey.html#method.try_with).
225 #[unstable(feature = "thread_local_state",
226 reason = "state querying was recently added",
228 pub struct AccessError {
232 #[unstable(feature = "thread_local_state",
233 reason = "state querying was recently added",
235 impl fmt::Debug for AccessError {
236 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
237 f.debug_struct("AccessError").finish()
241 #[unstable(feature = "thread_local_state",
242 reason = "state querying was recently added",
244 impl fmt::Display for AccessError {
245 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
246 fmt::Display::fmt("already destroyed", f)
250 impl<T: 'static> LocalKey<T> {
252 #[unstable(feature = "thread_local_internals",
253 reason = "recently added to create a key",
255 pub const fn new(inner: fn() -> Option<&'static UnsafeCell<Option<T>>>,
256 init: fn() -> T) -> LocalKey<T> {
263 /// Acquires a reference to the value in this TLS key.
265 /// This will lazily initialize the value if this thread has not referenced
270 /// This function will `panic!()` if the key currently has its
271 /// destructor running, and it **may** panic if the destructor has
272 /// previously been run for this thread.
273 #[stable(feature = "rust1", since = "1.0.0")]
274 pub fn with<F, R>(&'static self, f: F) -> R
275 where F: FnOnce(&T) -> R {
276 self.try_with(f).expect("cannot access a TLS value during or \
277 after it is destroyed")
280 unsafe fn init(&self, slot: &UnsafeCell<Option<T>>) -> &T {
281 // Execute the initialization up front, *then* move it into our slot,
282 // just in case initialization fails.
283 let value = (self.init)();
284 let ptr = slot.get();
286 // note that this can in theory just be `*ptr = Some(value)`, but due to
287 // the compiler will currently codegen that pattern with something like:
289 // ptr::drop_in_place(ptr)
290 // ptr::write(ptr, Some(value))
292 // Due to this pattern it's possible for the destructor of the value in
293 // `ptr` (e.g. if this is being recursively initialized) to re-access
294 // TLS, in which case there will be a `&` and `&mut` pointer to the same
295 // value (an aliasing violation). To avoid setting the "I'm running a
296 // destructor" flag we just use `mem::replace` which should sequence the
297 // operations a little differently and make this safe to call.
298 mem::replace(&mut *ptr, Some(value));
300 (*ptr).as_ref().unwrap()
303 /// Query the current state of this key.
305 /// A key is initially in the `Uninitialized` state whenever a thread
306 /// starts. It will remain in this state up until the first call to [`with`]
307 /// within a thread has run the initialization expression successfully.
309 /// Once the initialization expression succeeds, the key transitions to the
310 /// `Valid` state which will guarantee that future calls to [`with`] will
311 /// succeed within the thread.
313 /// When a thread exits, each key will be destroyed in turn, and as keys are
314 /// destroyed they will enter the `Destroyed` state just before the
315 /// destructor starts to run. Keys may remain in the `Destroyed` state after
316 /// destruction has completed. Keys without destructors (e.g. with types
317 /// that are [`Copy`]), may never enter the `Destroyed` state.
319 /// Keys in the `Uninitialized` state can be accessed so long as the
320 /// initialization does not panic. Keys in the `Valid` state are guaranteed
321 /// to be able to be accessed. Keys in the `Destroyed` state will panic on
322 /// any call to [`with`].
324 /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
325 /// [`Copy`]: ../../std/marker/trait.Copy.html
326 #[unstable(feature = "thread_local_state",
327 reason = "state querying was recently added",
329 pub fn state(&'static self) -> LocalKeyState {
331 match (self.inner)() {
334 Some(..) => LocalKeyState::Valid,
335 None => LocalKeyState::Uninitialized,
338 None => LocalKeyState::Destroyed,
343 /// Acquires a reference to the value in this TLS key.
345 /// This will lazily initialize the value if this thread has not referenced
346 /// this key yet. If the key has been destroyed (which may happen if this is called
347 /// in a destructor), this function will return a ThreadLocalError.
351 /// This function will still `panic!()` if the key is uninitialized and the
352 /// key's initializer panics.
353 #[unstable(feature = "thread_local_state",
354 reason = "state querying was recently added",
356 pub fn try_with<F, R>(&'static self, f: F) -> Result<R, AccessError>
357 where F: FnOnce(&T) -> R {
359 let slot = (self.inner)().ok_or(AccessError {
362 Ok(f(match *slot.get() {
363 Some(ref inner) => inner,
364 None => self.init(slot),
371 #[cfg(target_thread_local)]
373 use cell::{Cell, UnsafeCell};
377 use sys::fast_thread_local::{register_dtor, requires_move_before_drop};
380 inner: UnsafeCell<Option<T>>,
382 // Metadata to keep track of the state of the destructor. Remember that
383 // these variables are thread-local, not global.
384 dtor_registered: Cell<bool>,
385 dtor_running: Cell<bool>,
388 impl<T> fmt::Debug for Key<T> {
389 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
394 unsafe impl<T> ::marker::Sync for Key<T> { }
397 pub const fn new() -> Key<T> {
399 inner: UnsafeCell::new(None),
400 dtor_registered: Cell::new(false),
401 dtor_running: Cell::new(false)
405 pub fn get(&'static self) -> Option<&'static UnsafeCell<Option<T>>> {
407 if mem::needs_drop::<T>() && self.dtor_running.get() {
410 self.register_dtor();
415 unsafe fn register_dtor(&self) {
416 if !mem::needs_drop::<T>() || self.dtor_registered.get() {
420 register_dtor(self as *const _ as *mut u8,
422 self.dtor_registered.set(true);
426 unsafe extern fn destroy_value<T>(ptr: *mut u8) {
427 let ptr = ptr as *mut Key<T>;
428 // Right before we run the user destructor be sure to flag the
429 // destructor as running for this thread so calls to `get` will return
431 (*ptr).dtor_running.set(true);
433 // Some implementations may require us to move the value before we drop
434 // it as it could get re-initialized in-place during destruction.
436 // Hence, we use `ptr::read` on those platforms (to move to a "safe"
437 // location) instead of drop_in_place.
438 if requires_move_before_drop() {
439 ptr::read((*ptr).inner.get());
441 ptr::drop_in_place((*ptr).inner.get());
448 use cell::{Cell, UnsafeCell};
452 use sys_common::thread_local::StaticKey as OsStaticKey;
455 // OS-TLS key that we'll use to key off.
457 marker: marker::PhantomData<Cell<T>>,
460 impl<T> fmt::Debug for Key<T> {
461 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
466 unsafe impl<T> ::marker::Sync for Key<T> { }
468 struct Value<T: 'static> {
469 key: &'static Key<T>,
470 value: UnsafeCell<Option<T>>,
473 impl<T: 'static> Key<T> {
474 pub const fn new() -> Key<T> {
476 os: OsStaticKey::new(Some(destroy_value::<T>)),
477 marker: marker::PhantomData
481 pub fn get(&'static self) -> Option<&'static UnsafeCell<Option<T>>> {
483 let ptr = self.os.get() as *mut Value<T>;
485 if ptr as usize == 1 {
488 return Some(&(*ptr).value);
491 // If the lookup returned null, we haven't initialized our own
492 // local copy, so do that now.
493 let ptr: Box<Value<T>> = box Value {
495 value: UnsafeCell::new(None),
497 let ptr = Box::into_raw(ptr);
498 self.os.set(ptr as *mut u8);
504 unsafe extern fn destroy_value<T: 'static>(ptr: *mut u8) {
505 // The OS TLS ensures that this key contains a NULL value when this
506 // destructor starts to run. We set it back to a sentinel value of 1 to
507 // ensure that any future calls to `get` for this thread will return
510 // Note that to prevent an infinite loop we reset it back to null right
511 // before we return from the destructor ourselves.
512 let ptr = Box::from_raw(ptr as *mut Value<T>);
514 key.os.set(1 as *mut u8);
516 key.os.set(ptr::null_mut());
520 #[cfg(all(test, not(target_os = "emscripten")))]
522 use sync::mpsc::{channel, Sender};
523 use cell::{Cell, UnsafeCell};
524 use super::LocalKeyState;
527 struct Foo(Sender<()>);
531 let Foo(ref s) = *self;
538 thread_local!(static FOO: Cell<i32> = Cell::new(1));
541 assert_eq!(f.get(), 1);
544 let (tx, rx) = channel();
545 let _t = thread::spawn(move|| {
547 assert_eq!(f.get(), 1);
549 tx.send(()).unwrap();
554 assert_eq!(f.get(), 2);
563 assert!(FOO.state() == LocalKeyState::Destroyed);
567 assert!(FOO.state() == LocalKeyState::Uninitialized);
570 thread_local!(static FOO: Foo = foo());
573 assert!(FOO.state() == LocalKeyState::Uninitialized);
575 assert!(FOO.state() == LocalKeyState::Valid);
577 assert!(FOO.state() == LocalKeyState::Valid);
578 }).join().ok().unwrap();
583 thread_local!(static FOO: UnsafeCell<Option<Foo>> = UnsafeCell::new(None));
585 let (tx, rx) = channel();
586 let _t = thread::spawn(move|| unsafe {
587 let mut tx = Some(tx);
589 *f.get() = Some(Foo(tx.take().unwrap()));
599 thread_local!(static K1: UnsafeCell<Option<S1>> = UnsafeCell::new(None));
600 thread_local!(static K2: UnsafeCell<Option<S2>> = UnsafeCell::new(None));
601 static mut HITS: u32 = 0;
607 if K2.state() == LocalKeyState::Destroyed {
611 K2.with(|s| *s.get() = Some(S2));
623 assert!(K1.state() != LocalKeyState::Destroyed);
625 K1.with(|s| *s.get() = Some(S1));
630 thread::spawn(move|| {
632 }).join().ok().unwrap();
636 fn self_referential() {
638 thread_local!(static K1: UnsafeCell<Option<S1>> = UnsafeCell::new(None));
642 assert!(K1.state() == LocalKeyState::Destroyed);
646 thread::spawn(move|| unsafe {
647 K1.with(|s| *s.get() = Some(S1));
648 }).join().ok().unwrap();
651 // Note that this test will deadlock if TLS destructors aren't run (this
652 // requires the destructor to be run to pass the test). macOS has a known bug
653 // where dtors-in-dtors may cancel other destructors, so we just ignore this
656 #[cfg_attr(target_os = "macos", ignore)]
657 fn dtors_in_dtors_in_dtors() {
658 struct S1(Sender<()>);
659 thread_local!(static K1: UnsafeCell<Option<S1>> = UnsafeCell::new(None));
660 thread_local!(static K2: UnsafeCell<Option<Foo>> = UnsafeCell::new(None));
664 let S1(ref tx) = *self;
666 if K2.state() != LocalKeyState::Destroyed {
667 K2.with(|s| *s.get() = Some(Foo(tx.clone())));
673 let (tx, rx) = channel();
674 let _t = thread::spawn(move|| unsafe {
675 let mut tx = Some(tx);
676 K1.with(|s| *s.get() = Some(S1(tx.take().unwrap())));
685 use collections::HashMap;
689 fn square(i: i32) -> i32 { i * i }
690 thread_local!(static FOO: i32 = square(3));
699 fn map() -> RefCell<HashMap<i32, i32>> {
700 let mut m = HashMap::new();
704 thread_local!(static FOO: RefCell<HashMap<i32, i32>> = map());
707 assert_eq!(map.borrow()[&1], 2);
713 thread_local!(static FOO: RefCell<Vec<u32>> = RefCell::new(vec![1, 2, 3]));
716 assert_eq!(vec.borrow().len(), 3);
717 vec.borrow_mut().push(4);
718 assert_eq!(vec.borrow()[3], 4);