nitric-lock 0.0.1

Deadlock prevention and lock ordering library
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
113
114
115

use std::{cell::UnsafeCell, marker::PhantomData, ops::Deref, ops::DerefMut};

use lock_api::RawMutex as Unused0;
use parking_lot::RawMutex;

use crate::{LockInfo, RawLockGuard, ReadLock, WriteLock};

pub fn new_mutex<T>(data: T, id: usize) -> Mutex<T> {
    Mutex {
        data: UnsafeCell::new(data),
        id,
        raw: RawMutex::INIT,
    }
}

pub struct Mutex<T> {
    data: UnsafeCell<T>,
    id: usize,
    raw: RawMutex,
}

impl<T> Mutex<T> {
    pub fn lock_id(&self) -> usize {
        self.id
    }

    // TODO: decide whether to expose them, and how
    // TODO: (simply exposing would easily allow deadlocks)
    /*
    pub unsafe fn lock(&self) -> MutexGuard<'_, T> {
        self.raw.lock();

        unsafe { self.acquire_guard() }
    }

    pub unsafe fn try_lock(&self) -> Option<MutexGuard<'_, T>> {
        match self.raw.try_lock() {
            true => unsafe { Some(self.acquire_guard()) },
            false => None,
        }
    }
    */

    pub unsafe fn raw(&self) -> &RawMutex {
        &self.raw
    }

    pub unsafe fn acquire_guard(&self) -> MutexGuard<'_, T> {
        MutexGuard {
            marker: PhantomData,
            mutex: self,
        }
    }
}

impl<'a, T> ReadLock<'a> for &'a Mutex<T>
where
    T: 'a,
{
    type Output = MutexGuard<'a, T>;

    unsafe fn lock_info(&self) -> LockInfo<'_> {
        LockInfo {
            id: self.lock_id(),
            guard: RawLockGuard::RawMutex(self.raw()),
        }
    }

    unsafe fn lock_unchecked(self) -> <Self as ReadLock<'a>>::Output {
        self.acquire_guard()
    }
}

impl<'a, T> WriteLock<'a> for &'a Mutex<T>
where
    T: 'a,
{
    type Output = MutexGuard<'a, T>;

    unsafe fn lock_info(&self) -> LockInfo<'_> {
        LockInfo {
            id: self.lock_id(),
            guard: RawLockGuard::RawMutex(self.raw()),
        }
    }

    unsafe fn lock_unchecked(self) -> <Self as WriteLock<'a>>::Output {
        self.acquire_guard()
    }
}

pub struct MutexGuard<'a, T> {
    marker: PhantomData<(&'a mut T, *mut ())>,
    mutex: &'a Mutex<T>,
}

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

    fn deref(&self) -> &<Self as Deref>::Target {
        unsafe { &*self.mutex.data.get() }
    }
}

impl<T> DerefMut for MutexGuard<'_, T> {
    fn deref_mut(&mut self) -> &mut <Self as Deref>::Target {
        unsafe { &mut *self.mutex.data.get() }
    }
}

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