osom_lib_arc 0.1.24

ABI-stable atomic reference counted pointers for osom_lib.
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
124
125
126
127
128

#![allow(clippy::cast_ptr_alignment)]

use core::{
    marker::PhantomData,
    ptr::NonNull,
    sync::atomic::{AtomicU32, Ordering},
};

use osom_lib_alloc::traits::Allocator;
use osom_lib_reprc::traits::ReprC;

use super::{errors::CArcError, layout::CArcLayout};

#[repr(transparent)]
#[must_use]
#[derive(Debug)]
pub struct InternalArc<T, TAllocator: Allocator> {
    ptr: *mut u8,
    _phantom: PhantomData<(T, TAllocator)>,
}

unsafe impl<T: ReprC, TAllocator: Allocator> ReprC for InternalArc<T, TAllocator> {
    const CHECK: () = {
        let () = T::CHECK;
        let () = TAllocator::CHECK;
    };
}

unsafe impl<T: Send, TAllocator: Allocator + Send> Send for InternalArc<T, TAllocator> {}
unsafe impl<T: Sync, TAllocator: Allocator + Sync> Sync for InternalArc<T, TAllocator> {}

impl<T, TAllocator: Allocator> InternalArc<T, TAllocator> {
    const LAYOUT: CArcLayout<T, TAllocator> = CArcLayout::new();

    #[inline]
    pub fn new(value: T) -> Result<Self, CArcError>
    where
        TAllocator: Default,
    {
        Self::with_allocator(value, TAllocator::default())
    }

    pub fn with_allocator(value: T, mut allocator: TAllocator) -> Result<Self, CArcError> {
        let ptr = allocator
            .allocate(Self::LAYOUT.total_layout)
            .map_err(|_| CArcError::AllocationError)?
            .as_ptr();

        let result = Self {
            ptr,
            _phantom: PhantomData,
        };

        unsafe {
            result.allocator_ptr().write(allocator);
            result.strong().store(1, Ordering::Relaxed);
            result.weak().store(1, Ordering::Relaxed);
            result.data_ptr().write(value);
        }

        Ok(result)
    }

    /// Compares the raw pointers of the two internal arcs.
    #[inline]
    pub fn raw_equals(&self, other: &Self) -> bool {
        core::ptr::eq(self.ptr, other.ptr)
    }

    #[inline]
    pub const fn strong(&self) -> &AtomicU32 {
        unsafe { &*self.ptr.add(Self::LAYOUT.strong_offset).cast::<AtomicU32>() }
    }

    #[inline]
    pub const fn weak(&self) -> &AtomicU32 {
        unsafe { &*self.ptr.add(Self::LAYOUT.weak_offset).cast::<AtomicU32>() }
    }

    #[inline]
    pub unsafe fn deallocate_memory(&self) {
        unsafe {
            let mut allocator = self.allocator_ptr().read();
            allocator.deallocate(NonNull::new_unchecked(self.ptr), Self::LAYOUT.total_layout);
        }
    }

    #[inline]
    pub const unsafe fn read_data(&self) -> T {
        unsafe { self.data_ptr().read() }
    }

    #[inline]
    pub const fn data(&self) -> &T {
        unsafe { &*self.data_ptr() }
    }

    #[inline]
    pub const fn clone(&self) -> Self {
        Self {
            ptr: self.ptr,
            _phantom: PhantomData,
        }
    }

    #[inline(always)]
    pub const fn raw_ptr(&self) -> *mut u8 {
        self.ptr
    }

    #[inline(always)]
    pub const fn from_raw_ptr(ptr: *mut u8) -> Self {
        Self {
            ptr,
            _phantom: PhantomData,
        }
    }

    #[inline]
    const fn data_ptr(&self) -> *mut T {
        unsafe { self.ptr.add(Self::LAYOUT.data_offset).cast::<T>() }
    }

    #[inline]
    const fn allocator_ptr(&self) -> *mut TAllocator {
        unsafe { self.ptr.add(Self::LAYOUT.allocator_offset).cast::<TAllocator>() }
    }
}