flashmap 0.2.0

A lock-free eventually consistent concurrent hash map.
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

#![allow(dead_code, unused_imports)]

#[cfg(feature = "loom")]
pub use loom::*;
#[cfg(not(feature = "loom"))]
pub use std::{sync, thread};

pub use track_access::*;

pub fn maybe_loom_model<F>(test: F)
where
    F: Fn() + Send + Sync + 'static,
{
    #[cfg(feature = "loom")]
    loom::model(test);
    #[cfg(not(feature = "loom"))]
    test();
}

#[cfg(feature = "loom")]
mod track_access {
    use loom::{alloc::Track, cell::UnsafeCell};
    use std::{
        borrow::Borrow,
        hash::{Hash, Hasher},
    };

    use flashmap::TrustedHashEq;

    pub struct TrackAccess<T>(Track<Box<UnsafeCell<T>>>);

    unsafe impl<T> TrustedHashEq for TrackAccess<T> where Self: Hash + Eq {}

    impl<T> TrackAccess<T> {
        pub fn new(val: T) -> Self {
            Self(Track::new(Box::new(UnsafeCell::new(val))))
        }

        pub fn get(&self) -> &T {
            self.0.get_ref().with(|ptr| unsafe { &*ptr })
        }

        pub fn get_mut(&mut self) -> &mut T {
            self.0.get_ref().with_mut(|ptr| unsafe { &mut *ptr })
        }
    }

    unsafe impl<T: Sync> Sync for TrackAccess<T> {}

    impl<T: PartialEq> PartialEq for TrackAccess<T> {
        fn eq(&self, other: &Self) -> bool {
            PartialEq::eq(self.get(), other.get())
        }
    }

    impl<T: Eq> Eq for TrackAccess<T> {}

    impl<T: Hash> Hash for TrackAccess<T> {
        fn hash<H: Hasher>(&self, state: &mut H) {
            Hash::hash(self.get(), state)
        }
    }

    impl<T> Borrow<T> for TrackAccess<T> {
        fn borrow(&self) -> &T {
            self.0.get_ref().with(|ptr| unsafe { &*ptr })
        }
    }
}

#[cfg(not(feature = "loom"))]
mod track_access {
    use std::borrow::Borrow;
    use std::hash::Hash;

    use flashmap::TrustedHashEq;

    // The intent is that the tests are run with miri which will do the tracking through the box
    #[derive(PartialEq, Eq, Hash)]
    pub struct TrackAccess<T>(Box<T>);

    unsafe impl<T> TrustedHashEq for TrackAccess<T> where Self: Hash + Eq {}

    impl<T> TrackAccess<T> {
        pub fn new(val: T) -> Self {
            Self(Box::new(val))
        }

        pub fn get(&self) -> &T {
            &self.0
        }

        pub fn get_mut(&mut self) -> &mut T {
            &mut self.0
        }
    }

    impl<T> Borrow<T> for TrackAccess<T> {
        fn borrow(&self) -> &T {
            &self.0
        }
    }
}