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 /// Publicity and attributes for each static 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     // empty (base case for the recursion)
 140     () => {};
 141
 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)*);
 146     );
 147
 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);
 151     );
 152 }
 153
 154 #[doc(hidden)]
 155 #[unstable(feature = "thread_local_internals",
 156            reason = "should not be necessary",
 157            issue = "0")]
 158 #[macro_export]
 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 }
 164
 165             fn __getit() -> $crate::option::Option<
 166                 &'static $crate::cell::UnsafeCell<
 167                     $crate::option::Option<$t>>>
 168             {
 169                 #[thread_local]
 170                 #[cfg(target_thread_local)]
 171                 static __KEY: $crate::thread::__FastLocalKeyInner<$t> =
 172                     $crate::thread::__FastLocalKeyInner::new();
 173
 174                 #[cfg(not(target_thread_local))]
 175                 static __KEY: $crate::thread::__OsLocalKeyInner<$t> =
 176                     $crate::thread::__OsLocalKeyInner::new();
 177
 178                 __KEY.get()
 179             }
 180
 181             $crate::thread::LocalKey::new(__getit, __init)
 182         };
 183     }
 184 }
 185
 186 /// Indicator of the state of a thread local storage key.
 187 #[unstable(feature = "thread_local_state",
 188            reason = "state querying was recently added",
 189            issue = "27716")]
 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.
 195     ///
 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.
 198     ///
 199     /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
 200     Uninitialized,
 201
 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.
 206     ///
 207     /// Keys in the `Valid` state will be guaranteed to yield a reference to the
 208     /// closure passed to [`with`].
 209     ///
 210     /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
 211     Valid,
 212
 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.
 216     ///
 217     /// Keys in the `Destroyed` states will trigger a panic when accessed via
 218     /// [`with`].
 219     ///
 220     /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
 221     Destroyed,
 222 }
 223
 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",
 227            issue = "27716")]
 228 pub struct AccessError {
 229     _private: (),
 230 }
 231
 232 #[unstable(feature = "thread_local_state",
 233            reason = "state querying was recently added",
 234            issue = "27716")]
 235 impl fmt::Debug for AccessError {
 236     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 237         f.debug_struct("AccessError").finish()
 238     }
 239 }
 240
 241 #[unstable(feature = "thread_local_state",
 242            reason = "state querying was recently added",
 243            issue = "27716")]
 244 impl fmt::Display for AccessError {
 245     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 246         fmt::Display::fmt("already destroyed", f)
 247     }
 248 }
 249
 250 impl<T: 'static> LocalKey<T> {
 251     #[doc(hidden)]
 252     #[unstable(feature = "thread_local_internals",
 253                reason = "recently added to create a key",
 254                issue = "0")]
 255     pub const fn new(inner: fn() -> Option<&'static UnsafeCell<Option<T>>>,
 256                      init: fn() -> T) -> LocalKey<T> {
 257         LocalKey {
 258             inner: inner,
 259             init: init,
 260         }
 261     }
 262
 263     /// Acquires a reference to the value in this TLS key.
 264     ///
 265     /// This will lazily initialize the value if this thread has not referenced
 266     /// this key yet.
 267     ///
 268     /// # Panics
 269     ///
 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")
 278     }
 279
 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();
 285
 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:
 288         //
 289         //      ptr::drop_in_place(ptr)
 290         //      ptr::write(ptr, Some(value))
 291         //
 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));
 299
 300         (*ptr).as_ref().unwrap()
 301     }
 302
 303     /// Query the current state of this key.
 304     ///
 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.
 308     ///
 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.
 312     ///
 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.
 318     ///
 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`].
 323     ///
 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",
 328                issue = "27716")]
 329     pub fn state(&'static self) -> LocalKeyState {
 330         unsafe {
 331             match (self.inner)() {
 332                 Some(cell) => {
 333                     match *cell.get() {
 334                         Some(..) => LocalKeyState::Valid,
 335                         None => LocalKeyState::Uninitialized,
 336                     }
 337                 }
 338                 None => LocalKeyState::Destroyed,
 339             }
 340         }
 341     }
 342
 343     /// Acquires a reference to the value in this TLS key.
 344     ///
 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.
 348     ///
 349     /// # Panics
 350     ///
 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",
 355                issue = "27716")]
 356     pub fn try_with<F, R>(&'static self, f: F) -> Result<R, AccessError>
 357                       where F: FnOnce(&T) -> R {
 358         unsafe {
 359             let slot = (self.inner)().ok_or(AccessError {
 360                 _private: (),
 361             })?;
 362             Ok(f(match *slot.get() {
 363                 Some(ref inner) => inner,
 364                 None => self.init(slot),
 365             }))
 366         }
 367     }
 368 }
 369
 370 #[doc(hidden)]
 371 #[cfg(target_thread_local)]
 372 pub mod fast {
 373     use cell::{Cell, UnsafeCell};
 374     use fmt;
 375     use mem;
 376     use ptr;
 377     use sys::fast_thread_local::{register_dtor, requires_move_before_drop};
 378
 379     pub struct Key<T> {
 380         inner: UnsafeCell<Option<T>>,
 381
 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>,
 386     }
 387
 388     impl<T> fmt::Debug for Key<T> {
 389         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 390             f.pad("Key { .. }")
 391         }
 392     }
 393
 394     unsafe impl<T> ::marker::Sync for Key<T> { }
 395
 396     impl<T> Key<T> {
 397         pub const fn new() -> Key<T> {
 398             Key {
 399                 inner: UnsafeCell::new(None),
 400                 dtor_registered: Cell::new(false),
 401                 dtor_running: Cell::new(false)
 402             }
 403         }
 404
 405         pub fn get(&'static self) -> Option<&'static UnsafeCell<Option<T>>> {
 406             unsafe {
 407                 if mem::needs_drop::<T>() && self.dtor_running.get() {
 408                     return None
 409                 }
 410                 self.register_dtor();
 411             }
 412             Some(&self.inner)
 413         }
 414
 415         unsafe fn register_dtor(&self) {
 416             if !mem::needs_drop::<T>() || self.dtor_registered.get() {
 417                 return
 418             }
 419
 420             register_dtor(self as *const _ as *mut u8,
 421                           destroy_value::<T>);
 422             self.dtor_registered.set(true);
 423         }
 424     }
 425
 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
 430         // `None`.
 431         (*ptr).dtor_running.set(true);
 432
 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.
 435         //
 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());
 440         } else {
 441             ptr::drop_in_place((*ptr).inner.get());
 442         }
 443     }
 444 }
 445
 446 #[doc(hidden)]
 447 pub mod os {
 448     use cell::{Cell, UnsafeCell};
 449     use fmt;
 450     use marker;
 451     use ptr;
 452     use sys_common::thread_local::StaticKey as OsStaticKey;
 453
 454     pub struct Key<T> {
 455         // OS-TLS key that we'll use to key off.
 456         os: OsStaticKey,
 457         marker: marker::PhantomData<Cell<T>>,
 458     }
 459
 460     impl<T> fmt::Debug for Key<T> {
 461         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 462             f.pad("Key { .. }")
 463         }
 464     }
 465
 466     unsafe impl<T> ::marker::Sync for Key<T> { }
 467
 468     struct Value<T: 'static> {
 469         key: &'static Key<T>,
 470         value: UnsafeCell<Option<T>>,
 471     }
 472
 473     impl<T: 'static> Key<T> {
 474         pub const fn new() -> Key<T> {
 475             Key {
 476                 os: OsStaticKey::new(Some(destroy_value::<T>)),
 477                 marker: marker::PhantomData
 478             }
 479         }
 480
 481         pub fn get(&'static self) -> Option<&'static UnsafeCell<Option<T>>> {
 482             unsafe {
 483                 let ptr = self.os.get() as *mut Value<T>;
 484                 if !ptr.is_null() {
 485                     if ptr as usize == 1 {
 486                         return None
 487                     }
 488                     return Some(&(*ptr).value);
 489                 }
 490
 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 {
 494                     key: self,
 495                     value: UnsafeCell::new(None),
 496                 };
 497                 let ptr = Box::into_raw(ptr);
 498                 self.os.set(ptr as *mut u8);
 499                 Some(&(*ptr).value)
 500             }
 501         }
 502     }
 503
 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
 508         // `None`.
 509         //
 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>);
 513         let key = ptr.key;
 514         key.os.set(1 as *mut u8);
 515         drop(ptr);
 516         key.os.set(ptr::null_mut());
 517     }
 518 }
 519
 520 #[cfg(all(test, not(target_os = "emscripten")))]
 521 mod tests {
 522     use sync::mpsc::{channel, Sender};
 523     use cell::{Cell, UnsafeCell};
 524     use super::LocalKeyState;
 525     use thread;
 526
 527     struct Foo(Sender<()>);
 528
 529     impl Drop for Foo {
 530         fn drop(&mut self) {
 531             let Foo(ref s) = *self;
 532             s.send(()).unwrap();
 533         }
 534     }
 535
 536     #[test]
 537     fn smoke_no_dtor() {
 538         thread_local!(static FOO: Cell<i32> = Cell::new(1));
 539
 540         FOO.with(|f| {
 541             assert_eq!(f.get(), 1);
 542             f.set(2);
 543         });
 544         let (tx, rx) = channel();
 545         let _t = thread::spawn(move|| {
 546             FOO.with(|f| {
 547                 assert_eq!(f.get(), 1);
 548             });
 549             tx.send(()).unwrap();
 550         });
 551         rx.recv().unwrap();
 552
 553         FOO.with(|f| {
 554             assert_eq!(f.get(), 2);
 555         });
 556     }
 557
 558     #[test]
 559     fn states() {
 560         struct Foo;
 561         impl Drop for Foo {
 562             fn drop(&mut self) {
 563                 assert!(FOO.state() == LocalKeyState::Destroyed);
 564             }
 565         }
 566         fn foo() -> Foo {
 567             assert!(FOO.state() == LocalKeyState::Uninitialized);
 568             Foo
 569         }
 570         thread_local!(static FOO: Foo = foo());
 571
 572         thread::spawn(|| {
 573             assert!(FOO.state() == LocalKeyState::Uninitialized);
 574             FOO.with(|_| {
 575                 assert!(FOO.state() == LocalKeyState::Valid);
 576             });
 577             assert!(FOO.state() == LocalKeyState::Valid);
 578         }).join().ok().unwrap();
 579     }
 580
 581     #[test]
 582     fn smoke_dtor() {
 583         thread_local!(static FOO: UnsafeCell<Option<Foo>> = UnsafeCell::new(None));
 584
 585         let (tx, rx) = channel();
 586         let _t = thread::spawn(move|| unsafe {
 587             let mut tx = Some(tx);
 588             FOO.with(|f| {
 589                 *f.get() = Some(Foo(tx.take().unwrap()));
 590             });
 591         });
 592         rx.recv().unwrap();
 593     }
 594
 595     #[test]
 596     fn circular() {
 597         struct S1;
 598         struct S2;
 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;
 602
 603         impl Drop for S1 {
 604             fn drop(&mut self) {
 605                 unsafe {
 606                     HITS += 1;
 607                     if K2.state() == LocalKeyState::Destroyed {
 608                         assert_eq!(HITS, 3);
 609                     } else {
 610                         if HITS == 1 {
 611                             K2.with(|s| *s.get() = Some(S2));
 612                         } else {
 613                             assert_eq!(HITS, 3);
 614                         }
 615                     }
 616                 }
 617             }
 618         }
 619         impl Drop for S2 {
 620             fn drop(&mut self) {
 621                 unsafe {
 622                     HITS += 1;
 623                     assert!(K1.state() != LocalKeyState::Destroyed);
 624                     assert_eq!(HITS, 2);
 625                     K1.with(|s| *s.get() = Some(S1));
 626                 }
 627             }
 628         }
 629
 630         thread::spawn(move|| {
 631             drop(S1);
 632         }).join().ok().unwrap();
 633     }
 634
 635     #[test]
 636     fn self_referential() {
 637         struct S1;
 638         thread_local!(static K1: UnsafeCell<Option<S1>> = UnsafeCell::new(None));
 639
 640         impl Drop for S1 {
 641             fn drop(&mut self) {
 642                 assert!(K1.state() == LocalKeyState::Destroyed);
 643             }
 644         }
 645
 646         thread::spawn(move|| unsafe {
 647             K1.with(|s| *s.get() = Some(S1));
 648         }).join().ok().unwrap();
 649     }
 650
 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
 654     // test on macOS.
 655     #[test]
 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));
 661
 662         impl Drop for S1 {
 663             fn drop(&mut self) {
 664                 let S1(ref tx) = *self;
 665                 unsafe {
 666                     if K2.state() != LocalKeyState::Destroyed {
 667                         K2.with(|s| *s.get() = Some(Foo(tx.clone())));
 668                     }
 669                 }
 670             }
 671         }
 672
 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())));
 677         });
 678         rx.recv().unwrap();
 679     }
 680 }
 681
 682 #[cfg(test)]
 683 mod dynamic_tests {
 684     use cell::RefCell;
 685     use collections::HashMap;
 686
 687     #[test]
 688     fn smoke() {
 689         fn square(i: i32) -> i32 { i * i }
 690         thread_local!(static FOO: i32 = square(3));
 691
 692         FOO.with(|f| {
 693             assert_eq!(*f, 9);
 694         });
 695     }
 696
 697     #[test]
 698     fn hashmap() {
 699         fn map() -> RefCell<HashMap<i32, i32>> {
 700             let mut m = HashMap::new();
 701             m.insert(1, 2);
 702             RefCell::new(m)
 703         }
 704         thread_local!(static FOO: RefCell<HashMap<i32, i32>> = map());
 705
 706         FOO.with(|map| {
 707             assert_eq!(map.borrow()[&1], 2);
 708         });
 709     }
 710
 711     #[test]
 712     fn refcell_vec() {
 713         thread_local!(static FOO: RefCell<Vec<u32>> = RefCell::new(vec![1, 2, 3]));
 714
 715         FOO.with(|vec| {
 716             assert_eq!(vec.borrow().len(), 3);
 717             vec.borrow_mut().push(4);
 718             assert_eq!(vec.borrow()[3], 4);
 719         });
 720     }
 721 }