armc 1.0.0

Armc is a rust implementation that facilitates Mutex access to variables.
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
106
107
108
109
110
111
112

use std::{
    hint::spin_loop,
    sync::{atomic::{AtomicBool, AtomicUsize, Ordering}}
};

pub(crate) struct Core<T> {
    count_ref: AtomicUsize,
    looked: AtomicBool,
    data: OptionCell<T>,
}

impl<T> Core<T> {
    pub fn new(data: T) -> Core<T> {
        Core {
            count_ref: AtomicUsize::default(),
            looked: AtomicBool::default(),
            data: OptionCell::new(data),
        }
    }
    pub fn lock(&self) -> ArmcGuard<'_, T> {
        while !self.looked.swap(true, Ordering::AcqRel)
            && self.count_ref.load(Ordering::Relaxed) > 0
        {
            spin_loop();
        }
        ArmcGuard { mutex: &self }
    }

    pub fn lock_ref(&self) -> ArmcRefGuard<'_, T> {
        while self.looked.load(Ordering::Relaxed) {
            spin_loop();
        }
        self.count_ref.fetch_add(1, Ordering::Relaxed);
        ArmcRefGuard { refex: &self }
    }

    fn drop(&self) {
        self.looked.store(false, Ordering::Release);
    }

    fn drop_ref(&self) {
        self.count_ref.fetch_sub(1, Ordering::Relaxed);
    }

    pub fn unwrap(a: Self) -> T {
        OptionCell::unwrap(a.data)
    }
}

use std::ops::{Deref, DerefMut};

use crate::option_cell::OptionCell;

pub struct ArmcGuard<'a, T> {
    mutex: &'a Core<T>,
}

pub struct ArmcRefGuard<'a, T> {
    refex: &'a Core<T>,
}

impl<T> Deref for Core<T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        while self.looked.load(Ordering::SeqCst) {
            spin_loop();
        }
        self.data.get_ref()
    }
}

impl<T> Deref for ArmcGuard<'_, T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        self.mutex.data.get_ref()
    }
}

impl<T> DerefMut for ArmcGuard<'_, T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        self.mutex.data.get_mut()
    }
}

impl<T> Drop for ArmcGuard<'_, T> {
    fn drop(&mut self) {
        self.mutex.drop()
    }
}

impl<T> Deref for ArmcRefGuard<'_, T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        self.refex.data.get_ref()
    }
}

impl<T> Drop for ArmcRefGuard<'_, T> {
    fn drop(&mut self) {
        self.refex.drop_ref()
    }
}

unsafe impl<T> Send for ArmcGuard<'_, T> where T: Send {}
unsafe impl<T> Sync for ArmcGuard<'_, T> where T: Send + Sync {}

unsafe impl<T> Send for Core<T> where T: Send {}
unsafe impl<T> Sync for Core<T> where T: Send {}