lockfree_object_pool/
page.rs

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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
use std::{
    cell::UnsafeCell,
    sync::atomic::{AtomicU32, Ordering},
};

pub struct Page<T> {
    data: [UnsafeCell<T>; 32],
    free: AtomicU32,
}

pub type PageId = u8;

impl<T> Page<T> {
    #[inline]
    pub fn new<I>(init: I) -> Self
    where
        I: Fn() -> T,
    {
        Self {
            data: [
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
                UnsafeCell::new(init()),
            ],
            free: AtomicU32::new(u32::MAX),
        }
    }

    #[cfg(test)]
    pub(crate) fn is_full(&self) -> bool {
        self.free.load(Ordering::Relaxed) == 0
    }

    #[cfg(test)]
    pub(crate) fn get_mask(&self) -> u32 {
        self.free.load(Ordering::Relaxed)
    }

    #[inline]
    pub fn alloc(&self) -> Option<PageId> {
        self.free
            .fetch_update(Ordering::SeqCst, Ordering::Relaxed, |free| {
                if free == 0 {
                    None
                } else {
                    Some(free & (free - 1))
                }
            })
            .ok()
            .map(|free| free.trailing_zeros() as u8)
    }

    #[inline]
    pub fn free(&self, id: &PageId) {
        let mask: u32 = 1 << id;
        self.free.fetch_or(mask, Ordering::SeqCst);
    }

    #[inline]
    pub unsafe fn get(&self, id: &PageId) -> &T {
        &*self.data[*id as usize].get()
    }

    #[inline]
    #[allow(clippy::mut_from_ref)] // the function is marked as unsafe for a reason
    pub unsafe fn get_mut(&self, id: &PageId) -> &mut T {
        &mut *self.data[*id as usize].get()
    }
}

unsafe impl<T: Send> Send for Page<T> {} // normal rules apply
unsafe impl<T: Sync> Sync for Page<T> {} // normal rules apply

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn test_page_01() {
        let page = Page::<u32>::new(|| 0);
        assert!(!page.is_full());
        assert_eq!(page.get_mask(), u32::MAX);
    }

    #[test]
    fn test_page_02() {
        let page = Page::<u32>::new(|| 0);

        let item1 = page.alloc();
        assert!(item1.is_some());
        assert_eq!(item1.unwrap(), 0);
        assert_eq!(
            format!("{:b}", page.get_mask()),
            "11111111111111111111111111111110"
        );

        let item2 = page.alloc();
        assert!(item2.is_some());
        assert_eq!(item2.unwrap(), 1);
        assert_eq!(
            format!("{:b}", page.get_mask()),
            "11111111111111111111111111111100"
        );

        let item3 = page.alloc();
        assert!(item3.is_some());
        assert_eq!(item3.unwrap(), 2);
        assert_eq!(
            format!("{:b}", page.get_mask()),
            "11111111111111111111111111111000"
        );

        page.free(&item2.unwrap());
        assert_eq!(
            format!("{:b}", page.get_mask()),
            "11111111111111111111111111111010"
        );

        page.free(&item1.unwrap());
        assert_eq!(
            format!("{:b}", page.get_mask()),
            "11111111111111111111111111111011"
        );

        page.free(&item3.unwrap());
        assert_eq!(
            format!("{:b}", page.get_mask()),
            "11111111111111111111111111111111"
        );
    }

    #[test]
    fn test_page_03() {
        let page = Page::<u32>::new(|| 0);
        for i in 0..32 {
            assert!(!page.is_full());

            let item = page.alloc();
            assert!(item.is_some());
            assert_eq!(item.unwrap(), i);
        }
        assert!(page.is_full());
        let item = page.alloc();
        assert!(item.is_none());
    }
}