mcslock 0.4.1

An implementation of Mellor-Crummey and Scott contention-free lock for mutual exclusion, referred to as MCS lock.
Documentation 
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

/// Non-recursive, inner definition of `thread_local_node!`.
///
/// This macro is **NOT** part of the public API and so must not be called
/// directly by user's code. It is subjected to changes **WITHOUT** prior
/// notice or accompanied with relevant SemVer changes.
#[cfg(not(all(loom, test)))]
#[doc(hidden)]
#[macro_export]
macro_rules! __thread_local_node_inner {
    ($vis:vis $node:ident, $($mod:ident)::+) => {
        $vis const $node: $crate::$($mod::)+LocalMutexNode = {
            ::std::thread_local! {
                static NODE: ::core::cell::RefCell<$crate::$($mod::)+MutexNode> = const {
                    ::core::cell::RefCell::new($crate::$($mod::)+MutexNode::new())
                };
            }
            $crate::$($mod::)+LocalMutexNode::__new(NODE)
        };
    };
}

/// Non-recursive, Loom based inner definition of `thread_local_node!`.
///
/// This node definition uses Loom primitives and it can't be evaluated at
/// compile-time since Loom does not support that feature. Loom's `thread_local!`
/// macro defines a `static` value as oppose to std's `const` value.
#[cfg(all(loom, test))]
#[macro_export]
macro_rules! __thread_local_node_inner {
    ($vis:vis $node:ident, $($mod:ident)::+) => {
        $vis static $node: $crate::$($mod::)+LocalMutexNode = {
            ::loom::thread_local! {
                static NODE: ::core::cell::RefCell<$crate::$($mod::)+MutexNode> = {
                    ::core::cell::RefCell::new($crate::$($mod::)+MutexNode::new())
                };
            }
            $crate::$($mod::)+LocalMutexNode::new(&NODE)
        };
    };
}

/// The local node error message as a string literal.
macro_rules! already_borrowed_error {
    () => {
        "mcslock's thread local node is already mutably borrowed"
    };
}