heapless 0.9.2

`static` friendly data structures that don't require dynamic memory allocation
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
116
117
118
119
120
121
122
123

use core::mem::ManuallyDrop;

#[cfg_attr(not(arm_llsc), path = "treiber/cas.rs")]
#[cfg_attr(arm_llsc, path = "treiber/llsc.rs")]
mod impl_;

pub use impl_::{AtomicPtr, NonNullPtr};

pub struct Stack<N>
where
    N: Node,
{
    top: AtomicPtr<N>,
}

impl<N> Stack<N>
where
    N: Node,
{
    pub const fn new() -> Self {
        Self {
            top: AtomicPtr::null(),
        }
    }

    /// # Safety
    /// - `node` must be a valid pointer
    /// - aliasing rules must be enforced by the caller. e.g, the same `node` may not be pushed more
    ///   than once
    /// - It must be valid to call `next()` on the `node`, meaning it must be properly initialized
    ///   for insertion into a stack/linked list
    pub unsafe fn push(&self, node: NonNullPtr<N>) {
        impl_::push(self, node);
    }

    pub fn try_pop(&self) -> Option<NonNullPtr<N>> {
        impl_::try_pop(self)
    }
}

pub trait Node: Sized {
    type Data;

    /// Returns a reference to the atomic pointer that stores the link to the next `Node`
    ///
    /// # Safety
    ///
    /// It must be valid to obtain a reference to the next link pointer, e.g. in the case of
    /// `UnionNode`, the `next` field must be properly initialized when calling this function
    unsafe fn next(&self) -> &AtomicPtr<Self>;

    /// Returns a mutable reference to the atomic pointer that stores the link to the next `Node`
    ///
    /// # Safety
    ///
    /// It must be valid to obtain a reference to the next link pointer, e.g. in the case of
    /// `UnionNode`, the `next` field must be properly initialized when calling this function
    #[allow(dead_code)] // used conditionally
    unsafe fn next_mut(&mut self) -> &mut AtomicPtr<Self>;
}

#[repr(C)]
pub union UnionNode<T> {
    next: ManuallyDrop<AtomicPtr<UnionNode<T>>>,
    pub data: ManuallyDrop<T>,
}

impl<T> UnionNode<T> {
    /// Returns a new `UnionNode` that does not contain data and is not linked to any other nodes.
    /// The return value of this function is guaranteed to have the `next` field properly
    /// initialized. Use this function if you want to insert a new `UnionNode` into a linked
    /// list
    pub const fn unlinked() -> Self {
        Self {
            next: ManuallyDrop::new(AtomicPtr::null()),
        }
    }
}

impl<T> Node for UnionNode<T> {
    type Data = T;

    unsafe fn next(&self) -> &AtomicPtr<Self> {
        // SAFETY: Caller ensures that `self.next` is properly initialized
        unsafe { &self.next }
    }

    unsafe fn next_mut(&mut self) -> &mut AtomicPtr<Self> {
        // SAFETY: Caller ensures that `self.next` is properly initialized
        unsafe { &mut self.next }
    }
}

pub struct StructNode<T> {
    pub next: ManuallyDrop<AtomicPtr<StructNode<T>>>,
    pub data: ManuallyDrop<T>,
}

impl<T> Node for StructNode<T> {
    type Data = T;

    unsafe fn next(&self) -> &AtomicPtr<Self> {
        &self.next
    }

    unsafe fn next_mut(&mut self) -> &mut AtomicPtr<Self> {
        &mut self.next
    }
}

#[cfg(test)]
mod tests {
    use core::mem;

    use super::*;

    #[test]
    fn node_is_never_zero_sized() {
        struct Zst;

        assert_ne!(mem::size_of::<UnionNode<Zst>>(), 0);
    }
}