third_party/rust/crossbeam-epoch-0.3.1/src/default.rs
author Bastien Orivel <eijebong@bananium.fr>
Wed, 22 Aug 2018 20:19:04 +0200
changeset 488156 03df1a267ea54f1024d3f015f4bf781477262c92
parent 456958 third_party/rust/crossbeam-epoch/src/default.rs@2f0342644d576df1d1c0bda70a629c019187e6f4
child 488275 85cd8690798999c98fde1394b1136af99298132b
permissions -rw-r--r--
Bug 1484462 - Revendor Rust dependencies. r=ato

//! The default garbage collector.
//!
//! For each thread, a participant is lazily initialized on its first use, when the current thread
//! is registered in the default collector.  If initialized, the thread's participant will get
//! destructed on thread exit, which in turn unregisters the thread.

use collector::{Collector, Handle};
use guard::Guard;

lazy_static! {
    /// The global data for the default garbage collector.
    static ref COLLECTOR: Collector = Collector::new();
}

thread_local! {
    /// The per-thread participant for the default garbage collector.
    static HANDLE: Handle = COLLECTOR.handle();
}

/// Pins the current thread.
#[inline]
pub fn pin() -> Guard {
    // FIXME(jeehoonkang): thread-local storage may be destructed at the time `pin()` is called. For
    // that case, we should use `HANDLE.try_with()` instead.
    HANDLE.with(|handle| handle.pin())
}

/// Returns `true` if the current thread is pinned.
#[inline]
pub fn is_pinned() -> bool {
    // FIXME(jeehoonkang): thread-local storage may be destructed at the time `pin()` is called. For
    // that case, we should use `HANDLE.try_with()` instead.
    HANDLE.with(|handle| handle.is_pinned())
}

/// Returns the default handle associated with the current thread.
#[inline]
pub fn default_handle() -> Handle {
    HANDLE.with(|handle| handle.clone())
}