      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539
    540
    541
    542
    543
    544
    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    602
    603
    604
    605
    606
    607
    608
    609
    610
    611
    612
    613
    614
    615
    616
    617
    618
    619
    620
    621
    622
    623
    624
    625
    626
    627
    628
    629
    630
    631
    632
    633
    634
    635
    636
    637
    638
    639
    640
    641
    642
    643
    644
    645
    646
    647
    648
    649
    650
    651
    652
    653
    654
    655
    656
    657
    658
    659
    660
    661
    662
    663
    664
    665
    666
    667
    668
    669
    670
    671
    672
    673
    674
    675
    676
    677
    678
    679
    680
    681
    682
    683
    684
    685
    686
    687
    688
    689
    690
    691
    692
    693
    694
    695
    696
    697
    698
    699
    700
    701
    702
    703
    704
    705
    706
    707
    708
    709
    710
    711
    712
    713
    714
    715
    716
    717
    718
    719
    720
    721
    722
    723
    724
    725
    726
    727
    728
    729
    730

    // Copyright 2014-2015 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    //! Thread local storage

    #![unstable(feature = "thread_local_internals", issue = "0")]

    use cell::UnsafeCell;
    use fmt;
    use mem;

    /// A thread local storage key which owns its contents.
    ///
    /// This key uses the fastest possible implementation available to it for the
    /// target platform. It is instantiated with the [`thread_local!`] macro and the
    /// primary method is the [`with`] method.
    ///
    /// The [`with`] method yields a reference to the contained value which cannot be
    /// sent across threads or escape the given closure.
    ///
    /// # Initialization and Destruction
    ///
    /// Initialization is dynamically performed on the first call to [`with`]
    /// within a thread, and values that implement [`Drop`] get destructed when a
    /// thread exits. Some caveats apply, which are explained below.
    ///
    /// A `LocalKey`'s initializer cannot recursively depend on itself, and using
    /// a `LocalKey` in this way will cause the initializer to infinitely recurse
    /// on the first call to `with`.
    ///
    /// # Examples
    ///
    /// ```
    /// use std::cell::RefCell;
    /// use std::thread;
    ///
    /// thread_local!(static FOO: RefCell<u32> = RefCell::new(1));
    ///
    /// FOO.with(|f| {
    ///     assert_eq!(*f.borrow(), 1);
    ///     *f.borrow_mut() = 2;
    /// });
    ///
    /// // each thread starts out with the initial value of 1
    /// thread::spawn(move|| {
    ///     FOO.with(|f| {
    ///         assert_eq!(*f.borrow(), 1);
    ///         *f.borrow_mut() = 3;
    ///     });
    /// });
    ///
    /// // we retain our original value of 2 despite the child thread
    /// FOO.with(|f| {
    ///     assert_eq!(*f.borrow(), 2);
    /// });
    /// ```
    ///
    /// # Platform-specific behavior
    ///
    /// Note that a "best effort" is made to ensure that destructors for types
    /// stored in thread local storage are run, but not all platforms can guarantee
    /// that destructors will be run for all types in thread local storage. For
    /// example, there are a number of known caveats where destructors are not run:
    ///
    /// 1. On Unix systems when pthread-based TLS is being used, destructors will
    ///    not be run for TLS values on the main thread when it exits. Note that the
    ///    application will exit immediately after the main thread exits as well.
    /// 2. On all platforms it's possible for TLS to re-initialize other TLS slots
    ///    during destruction. Some platforms ensure that this cannot happen
    ///    infinitely by preventing re-initialization of any slot that has been
    ///    destroyed, but not all platforms have this guard. Those platforms that do
    ///    not guard typically have a synthetic limit after which point no more
    ///    destructors are run.
    /// 3. On macOS, initializing TLS during destruction of other TLS slots can
    ///    sometimes cancel *all* destructors for the current thread, whether or not
    ///    the slots have already had their destructors run or not.
    ///
    /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
    /// [`thread_local!`]: ../../std/macro.thread_local.html
    /// [`Drop`]: ../../std/ops/trait.Drop.html
    #[stable(feature = "rust1", since = "1.0.0")]
    pub struct LocalKey<T: 'static> {
        // This outer `LocalKey<T>` type is what's going to be stored in statics,
        // but actual data inside will sometimes be tagged with #[thread_local].
        // It's not valid for a true static to reference a #[thread_local] static,
        // so we get around that by exposing an accessor through a layer of function
        // indirection (this thunk).
        //
        // Note that the thunk is itself unsafe because the returned lifetime of the
        // slot where data lives, `'static`, is not actually valid. The lifetime
        // here is actually slightly shorter than the currently running thread!
        //
        // Although this is an extra layer of indirection, it should in theory be
        // trivially devirtualizable by LLVM because the value of `inner` never
        // changes and the constant should be readonly within a crate. This mainly
        // only runs into problems when TLS statics are exported across crates.
        inner: unsafe fn() -> Option<&'static UnsafeCell<Option<T>>>,

        // initialization routine to invoke to create a value
        init: fn() -> T,
    }

    #[stable(feature = "std_debug", since = "1.16.0")]
    impl<T: 'static> fmt::Debug for LocalKey<T> {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            f.pad("LocalKey { .. }")
        }
    }

    /// Declare a new thread local storage key of type [`std::thread::LocalKey`].
    ///
    /// # Syntax
    ///
    /// The macro wraps any number of static declarations and makes them thread local.
    /// Publicity and attributes for each static are allowed. Example:
    ///
    /// ```
    /// use std::cell::RefCell;
    /// thread_local! {
    ///     pub static FOO: RefCell<u32> = RefCell::new(1);
    ///
    ///     #[allow(unused)]
    ///     static BAR: RefCell<f32> = RefCell::new(1.0);
    /// }
    /// # fn main() {}
    /// ```
    ///
    /// See [LocalKey documentation][`std::thread::LocalKey`] for more
    /// information.
    ///
    /// [`std::thread::LocalKey`]: ../std/thread/struct.LocalKey.html
    #[macro_export]
    #[stable(feature = "rust1", since = "1.0.0")]
    #[allow_internal_unstable]
    macro_rules! thread_local {
        // empty (base case for the recursion)
        () => {};

        // process multiple declarations
        ($(#[$attr:meta])* $vis:vis static $name:ident: $t:ty = $init:expr; $($rest:tt)*) => (
            __thread_local_inner!($(#[$attr])* $vis $name, $t, $init);
            thread_local!($($rest)*);
        );

        // handle a single declaration
        ($(#[$attr:meta])* $vis:vis static $name:ident: $t:ty = $init:expr) => (
            __thread_local_inner!($(#[$attr])* $vis $name, $t, $init);
        );
    }

    #[doc(hidden)]
    #[unstable(feature = "thread_local_internals",
               reason = "should not be necessary",
               issue = "0")]
    #[macro_export]
    #[allow_internal_unstable]
    #[allow_internal_unsafe]
    macro_rules! __thread_local_inner {
        (@key $(#[$attr:meta])* $vis:vis $name:ident, $t:ty, $init:expr) => {
            {
                #[inline]
                fn __init() -> $t { $init }

                unsafe fn __getit() -> $crate::option::Option<
                    &'static $crate::cell::UnsafeCell<
                        $crate::option::Option<$t>>>
                {
                    #[thread_local]
                    #[cfg(target_thread_local)]
                    static __KEY: $crate::thread::__FastLocalKeyInner<$t> =
                        $crate::thread::__FastLocalKeyInner::new();

                    #[cfg(not(target_thread_local))]
                    static __KEY: $crate::thread::__OsLocalKeyInner<$t> =
                        $crate::thread::__OsLocalKeyInner::new();

                    __KEY.get()
                }

                unsafe {
                    $crate::thread::LocalKey::new(__getit, __init)
                }
            }
        };
        ($(#[$attr:meta])* $vis:vis $name:ident, $t:ty, $init:expr) => {
            $(#[$attr])* $vis const $name: $crate::thread::LocalKey<$t> =
                __thread_local_inner!(@key $(#[$attr])* $vis $name, $t, $init);
        }
    }

    /// Indicator of the state of a thread local storage key.
    #[unstable(feature = "thread_local_state",
               reason = "state querying was recently added",
               issue = "27716")]
    #[derive(Debug, Eq, PartialEq, Copy, Clone)]
    pub enum LocalKeyState {
        /// All keys are in this state whenever a thread starts. Keys will
        /// transition to the `Valid` state once the first call to [`with`] happens
        /// and the initialization expression succeeds.
        ///
        /// Keys in the `Uninitialized` state will yield a reference to the closure
        /// passed to [`with`] so long as the initialization routine does not panic.
        ///
        /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
        Uninitialized,

        /// Once a key has been accessed successfully, it will enter the `Valid`
        /// state. Keys in the `Valid` state will remain so until the thread exits,
        /// at which point the destructor will be run and the key will enter the
        /// `Destroyed` state.
        ///
        /// Keys in the `Valid` state will be guaranteed to yield a reference to the
        /// closure passed to [`with`].
        ///
        /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
        Valid,

        /// When a thread exits, the destructors for keys will be run (if
        /// necessary). While a destructor is running, and possibly after a
        /// destructor has run, a key is in the `Destroyed` state.
        ///
        /// Keys in the `Destroyed` states will trigger a panic when accessed via
        /// [`with`].
        ///
        /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
        Destroyed,
    }

    /// An error returned by [`LocalKey::try_with`](struct.LocalKey.html#method.try_with).
    #[unstable(feature = "thread_local_state",
               reason = "state querying was recently added",
               issue = "27716")]
    pub struct AccessError {
        _private: (),
    }

    #[unstable(feature = "thread_local_state",
               reason = "state querying was recently added",
               issue = "27716")]
    impl fmt::Debug for AccessError {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            f.debug_struct("AccessError").finish()
        }
    }

    #[unstable(feature = "thread_local_state",
               reason = "state querying was recently added",
               issue = "27716")]
    impl fmt::Display for AccessError {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            fmt::Display::fmt("already destroyed", f)
        }
    }

    impl<T: 'static> LocalKey<T> {
        #[doc(hidden)]
        #[unstable(feature = "thread_local_internals",
                   reason = "recently added to create a key",
                   issue = "0")]
        pub const unsafe fn new(inner: unsafe fn() -> Option<&'static UnsafeCell<Option<T>>>,
                                init: fn() -> T) -> LocalKey<T> {
            LocalKey {
                inner,
                init,
            }
        }

        /// Acquires a reference to the value in this TLS key.
        ///
        /// This will lazily initialize the value if this thread has not referenced
        /// this key yet.
        ///
        /// # Panics
        ///
        /// This function will `panic!()` if the key currently has its
        /// destructor running, and it **may** panic if the destructor has
        /// previously been run for this thread.
        #[stable(feature = "rust1", since = "1.0.0")]
        pub fn with<F, R>(&'static self, f: F) -> R
                          where F: FnOnce(&T) -> R {
            self.try_with(f).expect("cannot access a TLS value during or \
                                     after it is destroyed")
        }

        unsafe fn init(&self, slot: &UnsafeCell<Option<T>>) -> &T {
            // Execute the initialization up front, *then* move it into our slot,
            // just in case initialization fails.
            let value = (self.init)();
            let ptr = slot.get();

            // note that this can in theory just be `*ptr = Some(value)`, but due to
            // the compiler will currently codegen that pattern with something like:
            //
            //      ptr::drop_in_place(ptr)
            //      ptr::write(ptr, Some(value))
            //
            // Due to this pattern it's possible for the destructor of the value in
            // `ptr` (e.g. if this is being recursively initialized) to re-access
            // TLS, in which case there will be a `&` and `&mut` pointer to the same
            // value (an aliasing violation). To avoid setting the "I'm running a
            // destructor" flag we just use `mem::replace` which should sequence the
            // operations a little differently and make this safe to call.
            mem::replace(&mut *ptr, Some(value));

            (*ptr).as_ref().unwrap()
        }

        /// Query the current state of this key.
        ///
        /// A key is initially in the `Uninitialized` state whenever a thread
        /// starts. It will remain in this state up until the first call to [`with`]
        /// within a thread has run the initialization expression successfully.
        ///
        /// Once the initialization expression succeeds, the key transitions to the
        /// `Valid` state which will guarantee that future calls to [`with`] will
        /// succeed within the thread. Some keys might skip the `Uninitialized`
        /// state altogether and start in the `Valid` state as an optimization
        /// (e.g. keys initialized with a constant expression), but no guarantees
        /// are made.
        ///
        /// When a thread exits, each key will be destroyed in turn, and as keys are
        /// destroyed they will enter the `Destroyed` state just before the
        /// destructor starts to run. Keys may remain in the `Destroyed` state after
        /// destruction has completed. Keys without destructors (e.g. with types
        /// that are [`Copy`]), may never enter the `Destroyed` state.
        ///
        /// Keys in the `Uninitialized` state can be accessed so long as the
        /// initialization does not panic. Keys in the `Valid` state are guaranteed
        /// to be able to be accessed. Keys in the `Destroyed` state will panic on
        /// any call to [`with`].
        ///
        /// [`with`]: ../../std/thread/struct.LocalKey.html#method.with
        /// [`Copy`]: ../../std/marker/trait.Copy.html
        #[unstable(feature = "thread_local_state",
                   reason = "state querying was recently added",
                   issue = "27716")]
        pub fn state(&'static self) -> LocalKeyState {
            unsafe {
                match (self.inner)() {
                    Some(cell) => {
                        match *cell.get() {
                            Some(..) => LocalKeyState::Valid,
                            None => LocalKeyState::Uninitialized,
                        }
                    }
                    None => LocalKeyState::Destroyed,
                }
            }
        }

        /// Acquires a reference to the value in this TLS key.
        ///
        /// This will lazily initialize the value if this thread has not referenced
        /// this key yet. If the key has been destroyed (which may happen if this is called
        /// in a destructor), this function will return a ThreadLocalError.
        ///
        /// # Panics
        ///
        /// This function will still `panic!()` if the key is uninitialized and the
        /// key's initializer panics.
        #[unstable(feature = "thread_local_state",
                   reason = "state querying was recently added",
                   issue = "27716")]
        pub fn try_with<F, R>(&'static self, f: F) -> Result<R, AccessError>
                          where F: FnOnce(&T) -> R {
            unsafe {
                let slot = (self.inner)().ok_or(AccessError {
                    _private: (),
                })?;
                Ok(f(match *slot.get() {
                    Some(ref inner) => inner,
                    None => self.init(slot),
                }))
            }
        }
    }

    #[doc(hidden)]
    #[cfg(target_thread_local)]
    pub mod fast {
        use cell::{Cell, UnsafeCell};
        use fmt;
        use mem;
        use ptr;
        use sys::fast_thread_local::{register_dtor, requires_move_before_drop};

        pub struct Key<T> {
            inner: UnsafeCell<Option<T>>,

            // Metadata to keep track of the state of the destructor. Remember that
            // these variables are thread-local, not global.
            dtor_registered: Cell<bool>,
            dtor_running: Cell<bool>,
        }

        impl<T> fmt::Debug for Key<T> {
            fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
                f.pad("Key { .. }")
            }
        }

        impl<T> Key<T> {
            pub const fn new() -> Key<T> {
                Key {
                    inner: UnsafeCell::new(None),
                    dtor_registered: Cell::new(false),
                    dtor_running: Cell::new(false)
                }
            }

            pub unsafe fn get(&self) -> Option<&'static UnsafeCell<Option<T>>> {
                if mem::needs_drop::<T>() && self.dtor_running.get() {
                    return None
                }
                self.register_dtor();
                Some(&*(&self.inner as *const _))
            }

            unsafe fn register_dtor(&self) {
                if !mem::needs_drop::<T>() || self.dtor_registered.get() {
                    return
                }

                register_dtor(self as *const _ as *mut u8,
                              destroy_value::<T>);
                self.dtor_registered.set(true);
            }
        }

        unsafe extern fn destroy_value<T>(ptr: *mut u8) {
            let ptr = ptr as *mut Key<T>;
            // Right before we run the user destructor be sure to flag the
            // destructor as running for this thread so calls to `get` will return
            // `None`.
            (*ptr).dtor_running.set(true);

            // Some implementations may require us to move the value before we drop
            // it as it could get re-initialized in-place during destruction.
            //
            // Hence, we use `ptr::read` on those platforms (to move to a "safe"
            // location) instead of drop_in_place.
            if requires_move_before_drop() {
                ptr::read((*ptr).inner.get());
            } else {
                ptr::drop_in_place((*ptr).inner.get());
            }
        }
    }

    #[doc(hidden)]
    pub mod os {
        use cell::{Cell, UnsafeCell};
        use fmt;
        use marker;
        use ptr;
        use sys_common::thread_local::StaticKey as OsStaticKey;

        pub struct Key<T> {
            // OS-TLS key that we'll use to key off.
            os: OsStaticKey,
            marker: marker::PhantomData<Cell<T>>,
        }

        impl<T> fmt::Debug for Key<T> {
            fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
                f.pad("Key { .. }")
            }
        }

        unsafe impl<T> ::marker::Sync for Key<T> { }

        struct Value<T: 'static> {
            key: &'static Key<T>,
            value: UnsafeCell<Option<T>>,
        }

        impl<T: 'static> Key<T> {
            pub const fn new() -> Key<T> {
                Key {
                    os: OsStaticKey::new(Some(destroy_value::<T>)),
                    marker: marker::PhantomData
                }
            }

            pub unsafe fn get(&'static self) -> Option<&'static UnsafeCell<Option<T>>> {
                let ptr = self.os.get() as *mut Value<T>;
                if !ptr.is_null() {
                    if ptr as usize == 1 {
                        return None
                    }
                    return Some(&(*ptr).value);
                }

                // If the lookup returned null, we haven't initialized our own
                // local copy, so do that now.
                let ptr: Box<Value<T>> = box Value {
                    key: self,
                    value: UnsafeCell::new(None),
                };
                let ptr = Box::into_raw(ptr);
                self.os.set(ptr as *mut u8);
                Some(&(*ptr).value)
            }
        }

        unsafe extern fn destroy_value<T: 'static>(ptr: *mut u8) {
            // The OS TLS ensures that this key contains a NULL value when this
            // destructor starts to run. We set it back to a sentinel value of 1 to
            // ensure that any future calls to `get` for this thread will return
            // `None`.
            //
            // Note that to prevent an infinite loop we reset it back to null right
            // before we return from the destructor ourselves.
            let ptr = Box::from_raw(ptr as *mut Value<T>);
            let key = ptr.key;
            key.os.set(1 as *mut u8);
            drop(ptr);
            key.os.set(ptr::null_mut());
        }
    }

    #[cfg(all(test, not(target_os = "emscripten")))]
    mod tests {
        use sync::mpsc::{channel, Sender};
        use cell::{Cell, UnsafeCell};
        use super::LocalKeyState;
        use thread;

        struct Foo(Sender<()>);

        impl Drop for Foo {
            fn drop(&mut self) {
                let Foo(ref s) = *self;
                s.send(()).unwrap();
            }
        }

        #[test]
        fn smoke_no_dtor() {
            thread_local!(static FOO: Cell<i32> = Cell::new(1));

            FOO.with(|f| {
                assert_eq!(f.get(), 1);
                f.set(2);
            });
            let (tx, rx) = channel();
            let _t = thread::spawn(move|| {
                FOO.with(|f| {
                    assert_eq!(f.get(), 1);
                });
                tx.send(()).unwrap();
            });
            rx.recv().unwrap();

            FOO.with(|f| {
                assert_eq!(f.get(), 2);
            });
        }

        #[test]
        fn states() {
            struct Foo;
            impl Drop for Foo {
                fn drop(&mut self) {
                    assert!(FOO.state() == LocalKeyState::Destroyed);
                }
            }
            fn foo() -> Foo {
                assert!(FOO.state() == LocalKeyState::Uninitialized);
                Foo
            }
            thread_local!(static FOO: Foo = foo());

            thread::spawn(|| {
                assert!(FOO.state() == LocalKeyState::Uninitialized);
                FOO.with(|_| {
                    assert!(FOO.state() == LocalKeyState::Valid);
                });
                assert!(FOO.state() == LocalKeyState::Valid);
            }).join().ok().unwrap();
        }

        #[test]
        fn smoke_dtor() {
            thread_local!(static FOO: UnsafeCell<Option<Foo>> = UnsafeCell::new(None));

            let (tx, rx) = channel();
            let _t = thread::spawn(move|| unsafe {
                let mut tx = Some(tx);
                FOO.with(|f| {
                    *f.get() = Some(Foo(tx.take().unwrap()));
                });
            });
            rx.recv().unwrap();
        }

        #[test]
        fn circular() {
            struct S1;
            struct S2;
            thread_local!(static K1: UnsafeCell<Option<S1>> = UnsafeCell::new(None));
            thread_local!(static K2: UnsafeCell<Option<S2>> = UnsafeCell::new(None));
            static mut HITS: u32 = 0;

            impl Drop for S1 {
                fn drop(&mut self) {
                    unsafe {
                        HITS += 1;
                        if K2.state() == LocalKeyState::Destroyed {
                            assert_eq!(HITS, 3);
                        } else {
                            if HITS == 1 {
                                K2.with(|s| *s.get() = Some(S2));
                            } else {
                                assert_eq!(HITS, 3);
                            }
                        }
                    }
                }
            }
            impl Drop for S2 {
                fn drop(&mut self) {
                    unsafe {
                        HITS += 1;
                        assert!(K1.state() != LocalKeyState::Destroyed);
                        assert_eq!(HITS, 2);
                        K1.with(|s| *s.get() = Some(S1));
                    }
                }
            }

            thread::spawn(move|| {
                drop(S1);
            }).join().ok().unwrap();
        }

        #[test]
        fn self_referential() {
            struct S1;
            thread_local!(static K1: UnsafeCell<Option<S1>> = UnsafeCell::new(None));

            impl Drop for S1 {
                fn drop(&mut self) {
                    assert!(K1.state() == LocalKeyState::Destroyed);
                }
            }

            thread::spawn(move|| unsafe {
                K1.with(|s| *s.get() = Some(S1));
            }).join().ok().unwrap();
        }

        // Note that this test will deadlock if TLS destructors aren't run (this
        // requires the destructor to be run to pass the test). macOS has a known bug
        // where dtors-in-dtors may cancel other destructors, so we just ignore this
        // test on macOS.
        #[test]
        #[cfg_attr(target_os = "macos", ignore)]
        fn dtors_in_dtors_in_dtors() {
            struct S1(Sender<()>);
            thread_local!(static K1: UnsafeCell<Option<S1>> = UnsafeCell::new(None));
            thread_local!(static K2: UnsafeCell<Option<Foo>> = UnsafeCell::new(None));

            impl Drop for S1 {
                fn drop(&mut self) {
                    let S1(ref tx) = *self;
                    unsafe {
                        if K2.state() != LocalKeyState::Destroyed {
                            K2.with(|s| *s.get() = Some(Foo(tx.clone())));
                        }
                    }
                }
            }

            let (tx, rx) = channel();
            let _t = thread::spawn(move|| unsafe {
                let mut tx = Some(tx);
                K1.with(|s| *s.get() = Some(S1(tx.take().unwrap())));
            });
            rx.recv().unwrap();
        }
    }

    #[cfg(test)]
    mod dynamic_tests {
        use cell::RefCell;
        use collections::HashMap;

        #[test]
        fn smoke() {
            fn square(i: i32) -> i32 { i * i }
            thread_local!(static FOO: i32 = square(3));

            FOO.with(|f| {
                assert_eq!(*f, 9);
            });
        }

        #[test]
        fn hashmap() {
            fn map() -> RefCell<HashMap<i32, i32>> {
                let mut m = HashMap::new();
                m.insert(1, 2);
                RefCell::new(m)
            }
            thread_local!(static FOO: RefCell<HashMap<i32, i32>> = map());

            FOO.with(|map| {
                assert_eq!(map.borrow()[&1], 2);
            });
        }

        #[test]
        fn refcell_vec() {
            thread_local!(static FOO: RefCell<Vec<u32>> = RefCell::new(vec![1, 2, 3]));

            FOO.with(|vec| {
                assert_eq!(vec.borrow().len(), 3);
                vec.borrow_mut().push(4);
                assert_eq!(vec.borrow()[3], 4);
            });
        }
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
↑
  Move up in search results
↓
  Move down in search results
↹
  Switch tab
⏎
  Go to active search result
+ / -
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)