src/libstd/thread/local.rs

   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.
   4 //
   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.
  10
  11 //! Thread local storage
  12
  13 #![unstable(feature = "thread_local_internals", issue = "0")]
  14
  15 use cell::UnsafeCell;
  16 use fmt;
  17 use mem;
  18
  19 /// A thread local storage key which owns its contents.
  20 ///
  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.
  24 ///
  25 /// The [`with`] method yields a reference to the contained value which cannot be
  26 /// sent across threads or escape the given closure.
  27 ///
  28 /// # Initialization and Destruction
  29 ///
  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.
  33 ///
  34 /// # Examples
  35 ///
  36 /// ```
  37 /// use std::cell::RefCell;
  38 /// use std::thread;
  39 ///
  40 /// thread_local!(static FOO: RefCell<u32> = RefCell::new(1));
  41 ///
  42 /// FOO.with(|f| {
  43 ///     assert_eq!(*f.borrow(), 1);
  44 ///     *f.borrow_mut() = 2;
  45 /// });
  46 ///
  47 /// // each thread starts out with the initial value of 1
  48 /// thread::spawn(move|| {
  49 ///     FOO.with(|f| {
  50 ///         assert_eq!(*f.borrow(), 1);
  51 ///         *f.borrow_mut() = 3;
  52 ///     });
  53 /// });
  54 ///
  55 /// // we retain our original value of 2 despite the child thread
  56 /// FOO.with(|f| {
  57 ///     assert_eq!(*f.borrow(), 2);
  58 /// });
  59 /// ```
  60 ///
  61 /// # Platform-specific behavior
  62 ///
  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:
  67 ///
  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.
  80 ///
  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).
  91     //
  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`!
  95     //
  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>>>,
 101
 102     // initialization routine to invoke to create a value
 103     init: fn() -> T,
 104 }
 105
 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 { .. }")
 110     }
 111 }
 112
 113 /// Declare a new thread local storage key of type [`std::thread::LocalKey`].
 114 ///
 115 /// # Syntax
 116 ///
 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:
 119 ///
 120 /// ```
 121 /// use std::cell::RefCell;
 122 /// thread_local! {
 123 ///     pub static FOO: RefCell<u32> = RefCell::new(1);
 124 ///
 125 ///     #[allow(unused)]
 126 ///     static BAR: RefCell<f32> = RefCell::new(1.0);
 127 /// }
 128 /// # fn main() {}
 129 /// ```
 130 ///
 131 /// See [LocalKey documentation][`std::thread::LocalKey`] for more
 132 /// information.
 133 ///
 134 /// [`std::thread::LocalKey`]: ../std/thread/struct.LocalKey.html
 135 #[macro_export]
 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)
 140     () => {};
 141
 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)*);
 146     );
 147
 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);
 152     );
 153
 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)*);
 158     );
 159
 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);
 164     );
 165 }
 166
 167 #[doc(hidden)]
 168 #[unstable(feature = "thread_local_internals",
 169            reason = "should not be necessary",
 170            issue = "0")]
 171 #[macro_export]
 172 #[allow_internal_unstable]
 173 macro_rules! __thread_local_inner {
 174     ($t:ty, $init:expr) => {{
 175         fn __init() -> $t { $init }
 176
 177         fn __getit() -> $crate::option::Option<
 178             &'static $crate::cell::UnsafeCell<
 179                 $crate::option::Option<$t>>>
 180         {
 181             #[thread_local]
 182             #[cfg(target_thread_local)]
 183             static __KEY: $crate::thread::__FastLocalKeyInner<$t> =
 184                 $crate::thread::__FastLocalKeyInner::new();
 185
 186             #[cfg(not(target_thread_local))]
 187             static __KEY: $crate::thread::__OsLocalKeyInner<$t> =
 188                 $crate::thread::__OsLocalKeyInner::new();
 189
 190             __KEY.get()
 191         }
 192
 193         $crate::thread::LocalKey::new(__getit, __init)
 194     }}
 195 }
 196
 197 /// Indicator of the state of a thread local storage key.
 198 #[unstable(feature = "thread_local_state",
 199            reason = "state querying was recently added",
 200            issue = "27716")]
 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.
 206     ///
 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.
 209     ///
 210     /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
 211     Uninitialized,
 212
 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.
 217     ///
 218     /// Keys in the `Valid` state will be guaranteed to yield a reference to the
 219     /// closure passed to [`with`].
 220     ///
 221     /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
 222     Valid,
 223
 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.
 227     ///
 228     /// Keys in the `Destroyed` states will trigger a panic when accessed via
 229     /// [`with`].
 230     ///
 231     /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
 232     Destroyed,
 233 }
 234
 235 impl<T: 'static> LocalKey<T> {
 236     #[doc(hidden)]
 237     #[unstable(feature = "thread_local_internals",
 238                reason = "recently added to create a key",
 239                issue = "0")]
 240     pub const fn new(inner: fn() -> Option<&'static UnsafeCell<Option<T>>>,
 241                      init: fn() -> T) -> LocalKey<T> {
 242         LocalKey {
 243             inner: inner,
 244             init: init,
 245         }
 246     }
 247
 248     /// Acquires a reference to the value in this TLS key.
 249     ///
 250     /// This will lazily initialize the value if this thread has not referenced
 251     /// this key yet.
 252     ///
 253     /// # Panics
 254     ///
 255     /// This function will `panic!()` if the key currently has its
 256     /// destructor running, and it **may** panic if the destructor has
 257     /// previously been run for this thread.
 258     #[stable(feature = "rust1", since = "1.0.0")]
 259     pub fn with<F, R>(&'static self, f: F) -> R
 260                       where F: FnOnce(&T) -> R {
 261         unsafe {
 262             let slot = (self.inner)();
 263             let slot = slot.expect("cannot access a TLS value during or \
 264                                     after it is destroyed");
 265             f(match *slot.get() {
 266                 Some(ref inner) => inner,
 267                 None => self.init(slot),
 268             })
 269         }
 270     }
 271
 272     unsafe fn init(&self, slot: &UnsafeCell<Option<T>>) -> &T {
 273         // Execute the initialization up front, *then* move it into our slot,
 274         // just in case initialization fails.
 275         let value = (self.init)();
 276         let ptr = slot.get();
 277
 278         // note that this can in theory just be `*ptr = Some(value)`, but due to
 279         // the compiler will currently codegen that pattern with something like:
 280         //
 281         //      ptr::drop_in_place(ptr)
 282         //      ptr::write(ptr, Some(value))
 283         //
 284         // Due to this pattern it's possible for the destructor of the value in
 285         // `ptr` (e.g. if this is being recursively initialized) to re-access
 286         // TLS, in which case there will be a `&` and `&mut` pointer to the same
 287         // value (an aliasing violation). To avoid setting the "I'm running a
 288         // destructor" flag we just use `mem::replace` which should sequence the
 289         // operations a little differently and make this safe to call.
 290         mem::replace(&mut *ptr, Some(value));
 291
 292         (*ptr).as_ref().unwrap()
 293     }
 294
 295     /// Query the current state of this key.
 296     ///
 297     /// A key is initially in the `Uninitialized` state whenever a thread
 298     /// starts. It will remain in this state up until the first call to [`with`]
 299     /// within a thread has run the initialization expression successfully.
 300     ///
 301     /// Once the initialization expression succeeds, the key transitions to the
 302     /// `Valid` state which will guarantee that future calls to [`with`] will
 303     /// succeed within the thread.
 304     ///
 305     /// When a thread exits, each key will be destroyed in turn, and as keys are
 306     /// destroyed they will enter the `Destroyed` state just before the
 307     /// destructor starts to run. Keys may remain in the `Destroyed` state after
 308     /// destruction has completed. Keys without destructors (e.g. with types
 309     /// that are [`Copy`]), may never enter the `Destroyed` state.
 310     ///
 311     /// Keys in the `Uninitialized` state can be accessed so long as the
 312     /// initialization does not panic. Keys in the `Valid` state are guaranteed
 313     /// to be able to be accessed. Keys in the `Destroyed` state will panic on
 314     /// any call to [`with`].
 315     ///
 316     /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
 317     /// [`Copy`]: ../../std/marker/trait.Copy.html
 318     #[unstable(feature = "thread_local_state",
 319                reason = "state querying was recently added",
 320                issue = "27716")]
 321     pub fn state(&'static self) -> LocalKeyState {
 322         unsafe {
 323             match (self.inner)() {
 324                 Some(cell) => {
 325                     match *cell.get() {
 326                         Some(..) => LocalKeyState::Valid,
 327                         None => LocalKeyState::Uninitialized,
 328                     }
 329                 }
 330                 None => LocalKeyState::Destroyed,
 331             }
 332         }
 333     }
 334 }
 335
 336 #[doc(hidden)]
 337 pub mod os {
 338     use cell::{Cell, UnsafeCell};
 339     use fmt;
 340     use marker;
 341     use ptr;
 342     use sys_common::thread_local::StaticKey as OsStaticKey;
 343
 344     pub struct Key<T> {
 345         // OS-TLS key that we'll use to key off.
 346         os: OsStaticKey,
 347         marker: marker::PhantomData<Cell<T>>,
 348     }
 349
 350     impl<T> fmt::Debug for Key<T> {
 351         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 352             f.pad("Key { .. }")
 353         }
 354     }
 355
 356     unsafe impl<T> ::marker::Sync for Key<T> { }
 357
 358     struct Value<T: 'static> {
 359         key: &'static Key<T>,
 360         value: UnsafeCell<Option<T>>,
 361     }
 362
 363     impl<T: 'static> Key<T> {
 364         pub const fn new() -> Key<T> {
 365             Key {
 366                 os: OsStaticKey::new(Some(destroy_value::<T>)),
 367                 marker: marker::PhantomData
 368             }
 369         }
 370
 371         pub fn get(&'static self) -> Option<&'static UnsafeCell<Option<T>>> {
 372             unsafe {
 373                 let ptr = self.os.get() as *mut Value<T>;
 374                 if !ptr.is_null() {
 375                     if ptr as usize == 1 {
 376                         return None
 377                     }
 378                     return Some(&(*ptr).value);
 379                 }
 380
 381                 // If the lookup returned null, we haven't initialized our own local
 382                 // copy, so do that now.
 383                 let ptr: Box<Value<T>> = box Value {
 384                     key: self,
 385                     value: UnsafeCell::new(None),
 386                 };
 387                 let ptr = Box::into_raw(ptr);
 388                 self.os.set(ptr as *mut u8);
 389                 Some(&(*ptr).value)
 390             }
 391         }
 392     }
 393
 394     pub unsafe extern fn destroy_value<T: 'static>(ptr: *mut u8) {
 395         // The OS TLS ensures that this key contains a NULL value when this
 396         // destructor starts to run. We set it back to a sentinel value of 1 to
 397         // ensure that any future calls to `get` for this thread will return
 398         // `None`.
 399         //
 400         // Note that to prevent an infinite loop we reset it back to null right
 401         // before we return from the destructor ourselves.
 402         let ptr = Box::from_raw(ptr as *mut Value<T>);
 403         let key = ptr.key;
 404         key.os.set(1 as *mut u8);
 405         drop(ptr);
 406         key.os.set(ptr::null_mut());
 407     }
 408 }
 409
 410 #[cfg(all(test, not(target_os = "emscripten")))]
 411 mod tests {
 412     use sync::mpsc::{channel, Sender};
 413     use cell::{Cell, UnsafeCell};
 414     use super::LocalKeyState;
 415     use thread;
 416
 417     struct Foo(Sender<()>);
 418
 419     impl Drop for Foo {
 420         fn drop(&mut self) {
 421             let Foo(ref s) = *self;
 422             s.send(()).unwrap();
 423         }
 424     }
 425
 426     #[test]
 427     fn smoke_no_dtor() {
 428         thread_local!(static FOO: Cell<i32> = Cell::new(1));
 429
 430         FOO.with(|f| {
 431             assert_eq!(f.get(), 1);
 432             f.set(2);
 433         });
 434         let (tx, rx) = channel();
 435         let _t = thread::spawn(move|| {
 436             FOO.with(|f| {
 437                 assert_eq!(f.get(), 1);
 438             });
 439             tx.send(()).unwrap();
 440         });
 441         rx.recv().unwrap();
 442
 443         FOO.with(|f| {
 444             assert_eq!(f.get(), 2);
 445         });
 446     }
 447
 448     #[test]
 449     fn states() {
 450         struct Foo;
 451         impl Drop for Foo {
 452             fn drop(&mut self) {
 453                 assert!(FOO.state() == LocalKeyState::Destroyed);
 454             }
 455         }
 456         fn foo() -> Foo {
 457             assert!(FOO.state() == LocalKeyState::Uninitialized);
 458             Foo
 459         }
 460         thread_local!(static FOO: Foo = foo());
 461
 462         thread::spawn(|| {
 463             assert!(FOO.state() == LocalKeyState::Uninitialized);
 464             FOO.with(|_| {
 465                 assert!(FOO.state() == LocalKeyState::Valid);
 466             });
 467             assert!(FOO.state() == LocalKeyState::Valid);
 468         }).join().ok().unwrap();
 469     }
 470
 471     #[test]
 472     fn smoke_dtor() {
 473         thread_local!(static FOO: UnsafeCell<Option<Foo>> = UnsafeCell::new(None));
 474
 475         let (tx, rx) = channel();
 476         let _t = thread::spawn(move|| unsafe {
 477             let mut tx = Some(tx);
 478             FOO.with(|f| {
 479                 *f.get() = Some(Foo(tx.take().unwrap()));
 480             });
 481         });
 482         rx.recv().unwrap();
 483     }
 484
 485     #[test]
 486     fn circular() {
 487         struct S1;
 488         struct S2;
 489         thread_local!(static K1: UnsafeCell<Option<S1>> = UnsafeCell::new(None));
 490         thread_local!(static K2: UnsafeCell<Option<S2>> = UnsafeCell::new(None));
 491         static mut HITS: u32 = 0;
 492
 493         impl Drop for S1 {
 494             fn drop(&mut self) {
 495                 unsafe {
 496                     HITS += 1;
 497                     if K2.state() == LocalKeyState::Destroyed {
 498                         assert_eq!(HITS, 3);
 499                     } else {
 500                         if HITS == 1 {
 501                             K2.with(|s| *s.get() = Some(S2));
 502                         } else {
 503                             assert_eq!(HITS, 3);
 504                         }
 505                     }
 506                 }
 507             }
 508         }
 509         impl Drop for S2 {
 510             fn drop(&mut self) {
 511                 unsafe {
 512                     HITS += 1;
 513                     assert!(K1.state() != LocalKeyState::Destroyed);
 514                     assert_eq!(HITS, 2);
 515                     K1.with(|s| *s.get() = Some(S1));
 516                 }
 517             }
 518         }
 519
 520         thread::spawn(move|| {
 521             drop(S1);
 522         }).join().ok().unwrap();
 523     }
 524
 525     #[test]
 526     fn self_referential() {
 527         struct S1;
 528         thread_local!(static K1: UnsafeCell<Option<S1>> = UnsafeCell::new(None));
 529
 530         impl Drop for S1 {
 531             fn drop(&mut self) {
 532                 assert!(K1.state() == LocalKeyState::Destroyed);
 533             }
 534         }
 535
 536         thread::spawn(move|| unsafe {
 537             K1.with(|s| *s.get() = Some(S1));
 538         }).join().ok().unwrap();
 539     }
 540
 541     // Note that this test will deadlock if TLS destructors aren't run (this
 542     // requires the destructor to be run to pass the test). macOS has a known bug
 543     // where dtors-in-dtors may cancel other destructors, so we just ignore this
 544     // test on macOS.
 545     #[test]
 546     #[cfg_attr(target_os = "macos", ignore)]
 547     fn dtors_in_dtors_in_dtors() {
 548         struct S1(Sender<()>);
 549         thread_local!(static K1: UnsafeCell<Option<S1>> = UnsafeCell::new(None));
 550         thread_local!(static K2: UnsafeCell<Option<Foo>> = UnsafeCell::new(None));
 551
 552         impl Drop for S1 {
 553             fn drop(&mut self) {
 554                 let S1(ref tx) = *self;
 555                 unsafe {
 556                     if K2.state() != LocalKeyState::Destroyed {
 557                         K2.with(|s| *s.get() = Some(Foo(tx.clone())));
 558                     }
 559                 }
 560             }
 561         }
 562
 563         let (tx, rx) = channel();
 564         let _t = thread::spawn(move|| unsafe {
 565             let mut tx = Some(tx);
 566             K1.with(|s| *s.get() = Some(S1(tx.take().unwrap())));
 567         });
 568         rx.recv().unwrap();
 569     }
 570 }
 571
 572 #[cfg(test)]
 573 mod dynamic_tests {
 574     use cell::RefCell;
 575     use collections::HashMap;
 576
 577     #[test]
 578     fn smoke() {
 579         fn square(i: i32) -> i32 { i * i }
 580         thread_local!(static FOO: i32 = square(3));
 581
 582         FOO.with(|f| {
 583             assert_eq!(*f, 9);
 584         });
 585     }
 586
 587     #[test]
 588     fn hashmap() {
 589         fn map() -> RefCell<HashMap<i32, i32>> {
 590             let mut m = HashMap::new();
 591             m.insert(1, 2);
 592             RefCell::new(m)
 593         }
 594         thread_local!(static FOO: RefCell<HashMap<i32, i32>> = map());
 595
 596         FOO.with(|map| {
 597             assert_eq!(map.borrow()[&1], 2);
 598         });
 599     }
 600
 601     #[test]
 602     fn refcell_vec() {
 603         thread_local!(static FOO: RefCell<Vec<u32>> = RefCell::new(vec![1, 2, 3]));
 604
 605         FOO.with(|vec| {
 606             assert_eq!(vec.borrow().len(), 3);
 607             vec.borrow_mut().push(4);
 608             assert_eq!(vec.borrow()[3], 4);
 609         });
 610     }
 611 }