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 /// Each static may be public or private, and attributes 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 // rule 0: empty (base case for the recursion)
142 // rule 1: process multiple declarations where the first one is private
143 ($(#[$attr:meta])* static $name:ident: $t:ty = $init:expr; $($rest:tt)*) => (
144 thread_local!($(#[$attr])* static $name: $t = $init); // go to rule 2
145 thread_local!($($rest)*);
148 // rule 2: handle a single private declaration
149 ($(#[$attr:meta])* static $name:ident: $t:ty = $init:expr) => (
150 $(#[$attr])* static $name: $crate::thread::LocalKey<$t> =
151 __thread_local_inner!($t, $init);
154 // rule 3: handle multiple declarations where the first one is public
155 ($(#[$attr:meta])* pub static $name:ident: $t:ty = $init:expr; $($rest:tt)*) => (
156 thread_local!($(#[$attr])* pub static $name: $t = $init); // go to rule 4
157 thread_local!($($rest)*);
160 // rule 4: handle a single public declaration
161 ($(#[$attr:meta])* pub static $name:ident: $t:ty = $init:expr) => (
162 $(#[$attr])* pub static $name: $crate::thread::LocalKey<$t> =
163 __thread_local_inner!($t, $init);
168 #[unstable(feature = "thread_local_internals",
169 reason = "should not be necessary",
172 #[allow_internal_unstable]
173 macro_rules! __thread_local_inner {
174 ($t:ty, $init:expr) => {{
175 fn __init() -> $t { $init }
177 fn __getit() -> $crate::option::Option<
178 &'static $crate::cell::UnsafeCell<
179 $crate::option::Option<$t>>>
182 #[cfg(target_thread_local)]
183 static __KEY: $crate::thread::__FastLocalKeyInner<$t> =
184 $crate::thread::__FastLocalKeyInner::new();
186 #[cfg(not(target_thread_local))]
187 static __KEY: $crate::thread::__OsLocalKeyInner<$t> =
188 $crate::thread::__OsLocalKeyInner::new();
193 $crate::thread::LocalKey::new(__getit, __init)
197 /// Indicator of the state of a thread local storage key.
198 #[unstable(feature = "thread_local_state",
199 reason = "state querying was recently added",
201 #[derive(Debug, Eq, PartialEq, Copy, Clone)]
202 pub enum LocalKeyState {
203 /// All keys are in this state whenever a thread starts. Keys will
204 /// transition to the `Valid` state once the first call to [`with`] happens
205 /// and the initialization expression succeeds.
207 /// Keys in the `Uninitialized` state will yield a reference to the closure
208 /// passed to [`with`] so long as the initialization routine does not panic.
210 /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
213 /// Once a key has been accessed successfully, it will enter the `Valid`
214 /// state. Keys in the `Valid` state will remain so until the thread exits,
215 /// at which point the destructor will be run and the key will enter the
216 /// `Destroyed` state.
218 /// Keys in the `Valid` state will be guaranteed to yield a reference to the
219 /// closure passed to [`with`].
221 /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
224 /// When a thread exits, the destructors for keys will be run (if
225 /// necessary). While a destructor is running, and possibly after a
226 /// destructor has run, a key is in the `Destroyed` state.
228 /// Keys in the `Destroyed` states will trigger a panic when accessed via
231 /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
235 /// An error returned by [`LocalKey::try_with`](struct.LocalKey.html#method.try_with).
236 #[unstable(feature = "thread_local_state",
237 reason = "state querying was recently added",
239 pub struct AccessError {
243 #[unstable(feature = "thread_local_state",
244 reason = "state querying was recently added",
246 impl fmt::Debug for AccessError {
247 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
248 f.debug_struct("AccessError").finish()
252 #[unstable(feature = "thread_local_state",
253 reason = "state querying was recently added",
255 impl fmt::Display for AccessError {
256 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
257 fmt::Display::fmt("already destroyed", f)
261 impl<T: 'static> LocalKey<T> {
263 #[unstable(feature = "thread_local_internals",
264 reason = "recently added to create a key",
266 pub const fn new(inner: fn() -> Option<&'static UnsafeCell<Option<T>>>,
267 init: fn() -> T) -> LocalKey<T> {
274 /// Acquires a reference to the value in this TLS key.
276 /// This will lazily initialize the value if this thread has not referenced
281 /// This function will `panic!()` if the key currently has its
282 /// destructor running, and it **may** panic if the destructor has
283 /// previously been run for this thread.
284 #[stable(feature = "rust1", since = "1.0.0")]
285 pub fn with<F, R>(&'static self, f: F) -> R
286 where F: FnOnce(&T) -> R {
287 self.try_with(f).expect("cannot access a TLS value during or \
288 after it is destroyed")
291 unsafe fn init(&self, slot: &UnsafeCell<Option<T>>) -> &T {
292 // Execute the initialization up front, *then* move it into our slot,
293 // just in case initialization fails.
294 let value = (self.init)();
295 let ptr = slot.get();
297 // note that this can in theory just be `*ptr = Some(value)`, but due to
298 // the compiler will currently codegen that pattern with something like:
300 // ptr::drop_in_place(ptr)
301 // ptr::write(ptr, Some(value))
303 // Due to this pattern it's possible for the destructor of the value in
304 // `ptr` (e.g. if this is being recursively initialized) to re-access
305 // TLS, in which case there will be a `&` and `&mut` pointer to the same
306 // value (an aliasing violation). To avoid setting the "I'm running a
307 // destructor" flag we just use `mem::replace` which should sequence the
308 // operations a little differently and make this safe to call.
309 mem::replace(&mut *ptr, Some(value));
311 (*ptr).as_ref().unwrap()
314 /// Query the current state of this key.
316 /// A key is initially in the `Uninitialized` state whenever a thread
317 /// starts. It will remain in this state up until the first call to [`with`]
318 /// within a thread has run the initialization expression successfully.
320 /// Once the initialization expression succeeds, the key transitions to the
321 /// `Valid` state which will guarantee that future calls to [`with`] will
322 /// succeed within the thread.
324 /// When a thread exits, each key will be destroyed in turn, and as keys are
325 /// destroyed they will enter the `Destroyed` state just before the
326 /// destructor starts to run. Keys may remain in the `Destroyed` state after
327 /// destruction has completed. Keys without destructors (e.g. with types
328 /// that are [`Copy`]), may never enter the `Destroyed` state.
330 /// Keys in the `Uninitialized` state can be accessed so long as the
331 /// initialization does not panic. Keys in the `Valid` state are guaranteed
332 /// to be able to be accessed. Keys in the `Destroyed` state will panic on
333 /// any call to [`with`].
335 /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
336 /// [`Copy`]: ../../std/marker/trait.Copy.html
337 #[unstable(feature = "thread_local_state",
338 reason = "state querying was recently added",
340 pub fn state(&'static self) -> LocalKeyState {
342 match (self.inner)() {
345 Some(..) => LocalKeyState::Valid,
346 None => LocalKeyState::Uninitialized,
349 None => LocalKeyState::Destroyed,
354 /// Acquires a reference to the value in this TLS key.
356 /// This will lazily initialize the value if this thread has not referenced
357 /// this key yet. If the key has been destroyed (which may happen if this is called
358 /// in a destructor), this function will return a ThreadLocalError.
362 /// This function will still `panic!()` if the key is uninitialized and the
363 /// key's initializer panics.
364 #[unstable(feature = "thread_local_state",
365 reason = "state querying was recently added",
367 pub fn try_with<F, R>(&'static self, f: F) -> Result<R, AccessError>
368 where F: FnOnce(&T) -> R {
370 let slot = (self.inner)().ok_or(AccessError {
373 Ok(f(match *slot.get() {
374 Some(ref inner) => inner,
375 None => self.init(slot),
382 #[cfg(target_thread_local)]
384 use cell::{Cell, UnsafeCell};
388 use sys::fast_thread_local::{register_dtor, requires_move_before_drop};
391 inner: UnsafeCell<Option<T>>,
393 // Metadata to keep track of the state of the destructor. Remember that
394 // these variables are thread-local, not global.
395 dtor_registered: Cell<bool>,
396 dtor_running: Cell<bool>,
399 impl<T> fmt::Debug for Key<T> {
400 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
405 unsafe impl<T> ::marker::Sync for Key<T> { }
408 pub const fn new() -> Key<T> {
410 inner: UnsafeCell::new(None),
411 dtor_registered: Cell::new(false),
412 dtor_running: Cell::new(false)
416 pub fn get(&'static self) -> Option<&'static UnsafeCell<Option<T>>> {
418 if mem::needs_drop::<T>() && self.dtor_running.get() {
421 self.register_dtor();
426 unsafe fn register_dtor(&self) {
427 if !mem::needs_drop::<T>() || self.dtor_registered.get() {
431 register_dtor(self as *const _ as *mut u8,
433 self.dtor_registered.set(true);
437 unsafe extern fn destroy_value<T>(ptr: *mut u8) {
438 let ptr = ptr as *mut Key<T>;
439 // Right before we run the user destructor be sure to flag the
440 // destructor as running for this thread so calls to `get` will return
442 (*ptr).dtor_running.set(true);
444 // Some implementations may require us to move the value before we drop
445 // it as it could get re-initialized in-place during destruction.
447 // Hence, we use `ptr::read` on those platforms (to move to a "safe"
448 // location) instead of drop_in_place.
449 if requires_move_before_drop() {
450 ptr::read((*ptr).inner.get());
452 ptr::drop_in_place((*ptr).inner.get());
459 use cell::{Cell, UnsafeCell};
463 use sys_common::thread_local::StaticKey as OsStaticKey;
466 // OS-TLS key that we'll use to key off.
468 marker: marker::PhantomData<Cell<T>>,
471 impl<T> fmt::Debug for Key<T> {
472 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
477 unsafe impl<T> ::marker::Sync for Key<T> { }
479 struct Value<T: 'static> {
480 key: &'static Key<T>,
481 value: UnsafeCell<Option<T>>,
484 impl<T: 'static> Key<T> {
485 pub const fn new() -> Key<T> {
487 os: OsStaticKey::new(Some(destroy_value::<T>)),
488 marker: marker::PhantomData
492 pub fn get(&'static self) -> Option<&'static UnsafeCell<Option<T>>> {
494 let ptr = self.os.get() as *mut Value<T>;
496 if ptr as usize == 1 {
499 return Some(&(*ptr).value);
502 // If the lookup returned null, we haven't initialized our own
503 // local copy, so do that now.
504 let ptr: Box<Value<T>> = box Value {
506 value: UnsafeCell::new(None),
508 let ptr = Box::into_raw(ptr);
509 self.os.set(ptr as *mut u8);
515 unsafe extern fn destroy_value<T: 'static>(ptr: *mut u8) {
516 // The OS TLS ensures that this key contains a NULL value when this
517 // destructor starts to run. We set it back to a sentinel value of 1 to
518 // ensure that any future calls to `get` for this thread will return
521 // Note that to prevent an infinite loop we reset it back to null right
522 // before we return from the destructor ourselves.
523 let ptr = Box::from_raw(ptr as *mut Value<T>);
525 key.os.set(1 as *mut u8);
527 key.os.set(ptr::null_mut());
531 #[cfg(all(test, not(target_os = "emscripten")))]
533 use sync::mpsc::{channel, Sender};
534 use cell::{Cell, UnsafeCell};
535 use super::LocalKeyState;
538 struct Foo(Sender<()>);
542 let Foo(ref s) = *self;
549 thread_local!(static FOO: Cell<i32> = Cell::new(1));
552 assert_eq!(f.get(), 1);
555 let (tx, rx) = channel();
556 let _t = thread::spawn(move|| {
558 assert_eq!(f.get(), 1);
560 tx.send(()).unwrap();
565 assert_eq!(f.get(), 2);
574 assert!(FOO.state() == LocalKeyState::Destroyed);
578 assert!(FOO.state() == LocalKeyState::Uninitialized);
581 thread_local!(static FOO: Foo = foo());
584 assert!(FOO.state() == LocalKeyState::Uninitialized);
586 assert!(FOO.state() == LocalKeyState::Valid);
588 assert!(FOO.state() == LocalKeyState::Valid);
589 }).join().ok().unwrap();
594 thread_local!(static FOO: UnsafeCell<Option<Foo>> = UnsafeCell::new(None));
596 let (tx, rx) = channel();
597 let _t = thread::spawn(move|| unsafe {
598 let mut tx = Some(tx);
600 *f.get() = Some(Foo(tx.take().unwrap()));
610 thread_local!(static K1: UnsafeCell<Option<S1>> = UnsafeCell::new(None));
611 thread_local!(static K2: UnsafeCell<Option<S2>> = UnsafeCell::new(None));
612 static mut HITS: u32 = 0;
618 if K2.state() == LocalKeyState::Destroyed {
622 K2.with(|s| *s.get() = Some(S2));
634 assert!(K1.state() != LocalKeyState::Destroyed);
636 K1.with(|s| *s.get() = Some(S1));
641 thread::spawn(move|| {
643 }).join().ok().unwrap();
647 fn self_referential() {
649 thread_local!(static K1: UnsafeCell<Option<S1>> = UnsafeCell::new(None));
653 assert!(K1.state() == LocalKeyState::Destroyed);
657 thread::spawn(move|| unsafe {
658 K1.with(|s| *s.get() = Some(S1));
659 }).join().ok().unwrap();
662 // Note that this test will deadlock if TLS destructors aren't run (this
663 // requires the destructor to be run to pass the test). macOS has a known bug
664 // where dtors-in-dtors may cancel other destructors, so we just ignore this
667 #[cfg_attr(target_os = "macos", ignore)]
668 fn dtors_in_dtors_in_dtors() {
669 struct S1(Sender<()>);
670 thread_local!(static K1: UnsafeCell<Option<S1>> = UnsafeCell::new(None));
671 thread_local!(static K2: UnsafeCell<Option<Foo>> = UnsafeCell::new(None));
675 let S1(ref tx) = *self;
677 if K2.state() != LocalKeyState::Destroyed {
678 K2.with(|s| *s.get() = Some(Foo(tx.clone())));
684 let (tx, rx) = channel();
685 let _t = thread::spawn(move|| unsafe {
686 let mut tx = Some(tx);
687 K1.with(|s| *s.get() = Some(S1(tx.take().unwrap())));
696 use collections::HashMap;
700 fn square(i: i32) -> i32 { i * i }
701 thread_local!(static FOO: i32 = square(3));
710 fn map() -> RefCell<HashMap<i32, i32>> {
711 let mut m = HashMap::new();
715 thread_local!(static FOO: RefCell<HashMap<i32, i32>> = map());
718 assert_eq!(map.borrow()[&1], 2);
724 thread_local!(static FOO: RefCell<Vec<u32>> = RefCell::new(vec![1, 2, 3]));
727 assert_eq!(vec.borrow().len(), 3);
728 vec.borrow_mut().push(4);
729 assert_eq!(vec.borrow()[3], 4);