dualcache-ff 0.3.0

A wait-free, high-performance concurrent cache optimized for extreme read-to-write ratios.
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
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

#[cfg(not(feature = "std"))]
use alloc::vec::Vec;
#[cfg(feature = "std")]
use std::vec::Vec;

#[cfg(all(feature = "std", not(any(feature = "loom", loom))))]
pub use std::sync::Arc;

#[cfg(any(feature = "loom", loom))]
pub use loom::sync::Arc;

#[cfg(all(not(feature = "std"), not(any(feature = "loom", loom))))]
pub use alloc::sync::Arc;

#[cfg(not(any(feature = "loom", loom)))]
pub type ArcSlice<T> = Arc<[T]>;

#[cfg(any(feature = "loom", loom))]
pub type ArcSlice<T> = Arc<Vec<T>>;

#[cfg(not(any(feature = "loom", loom)))]
#[inline(always)]
pub fn new_arc_slice<T>(vec: Vec<T>) -> ArcSlice<T> {
    vec.into_boxed_slice().into()
}

#[cfg(any(feature = "loom", loom))]
#[inline(always)]
pub fn new_arc_slice<T>(vec: Vec<T>) -> ArcSlice<T> {
    Arc::new(vec)
}

pub mod atomic {
    #[cfg(not(any(feature = "loom", loom)))]
    pub use core::sync::atomic::{
        AtomicBool, AtomicPtr, AtomicU16, AtomicU32, AtomicU64, AtomicU8, AtomicUsize, Ordering,
    };

    #[cfg(any(feature = "loom", loom))]
    pub use loom::sync::atomic::{
        AtomicBool, AtomicPtr, AtomicU16, AtomicU32, AtomicU64, AtomicU8, AtomicUsize, Ordering,
    };
}

pub mod cell {
    #[cfg(not(any(feature = "loom", loom)))]
    pub struct UnsafeCell<T>(core::cell::UnsafeCell<T>);

    #[cfg(not(any(feature = "loom", loom)))]
    impl<T> UnsafeCell<T> {
        #[inline(always)]
        pub const fn new(data: T) -> Self {
            Self(core::cell::UnsafeCell::new(data))
        }

        #[inline(always)]
        pub fn get(&self) -> *mut T {
            self.0.get()
        }

        #[inline(always)]
        pub fn with<F, R>(&self, f: F) -> R
        where
            F: FnOnce(*const T) -> R,
        {
            f(self.0.get() as *const T)
        }

        #[inline(always)]
        pub fn with_mut<F, R>(&self, f: F) -> R
        where
            F: FnOnce(*mut T) -> R,
        {
            f(self.0.get())
        }
    }

    #[cfg(any(feature = "loom", loom))]
    pub use loom::cell::UnsafeCell;
}

#[cfg(target_has_atomic = "64")]
pub mod index_types {
    pub type AtomicIndex = super::atomic::AtomicU64;
    pub type IndexType = u64;
    pub const EMPTY: u64 = 0;
    pub const TOMBSTONE: u64 = u64::MAX;
    pub const TAG_SHIFT: usize = 48;
    pub const INDEX_MASK: u64 = 0x0000_FFFF_FFFF_FFFF;
    pub type AtomicTick = super::atomic::AtomicU64;
    pub type TickType = u64;
}

#[cfg(not(target_has_atomic = "64"))]
pub mod index_types {
    pub type AtomicIndex = super::atomic::AtomicU32;
    pub type IndexType = u32;
    pub const EMPTY: u32 = 0;
    pub const TOMBSTONE: u32 = u32::MAX;
    pub const TAG_SHIFT: usize = 24;
    pub const INDEX_MASK: u32 = 0x00FF_FFFF;
    // daemon_tick wraps naturally, u32 is sufficient if u64 atomics are missing.
    pub type AtomicTick = super::atomic::AtomicU32;
    pub type TickType = u32;
}