platform-mem 0.2.0

Memory for linksplatform
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::{
    alloc::Layout,
    fmt::{self, Formatter},
    marker::PhantomData,
    mem::{self, MaybeUninit},
    ptr::{self, NonNull},
    slice,
};

pub struct RawPlace<T> {
    ptr: NonNull<T>,
    len: usize, // use to drop at panic
    cap: usize, // usually `cap` is same `len`
    _marker: PhantomData<T>,
}

impl<T> RawPlace<T> {
    pub const fn dangling() -> Self {
        Self { ptr: NonNull::dangling(), len: 0, cap: 0, _marker: PhantomData }
    }

    pub fn cap(&self) -> usize {
        self.cap
    }

    pub unsafe fn as_slice(&self) -> &[T] {
        unsafe { slice::from_raw_parts(self.ptr.as_ptr(), self.len) }
    }

    pub unsafe fn as_slice_mut(&mut self) -> &mut [T] {
        unsafe { slice::from_raw_parts_mut(self.ptr.as_ptr(), self.len) }
    }

    pub fn current_memory(&self) -> Option<(NonNull<u8>, Layout)> {
        // rust does not support such types,
        // so we can do better by skipping some checks and avoid an unwrap.
        const { assert!(mem::size_of::<T>().is_multiple_of(mem::align_of::<T>())) };

        if self.cap == 0 {
            None
        } else {
            unsafe {
                let layout = Layout::from_size_align_unchecked(
                    mem::size_of::<T>().unchecked_mul(self.cap),
                    mem::align_of::<T>(),
                );
                Some((self.ptr.cast(), layout))
            }
        }
    }

    pub unsafe fn handle_fill(
        &mut self,
        (ptr, cap): (NonNull<T>, usize),
        inited: usize,
        fill: impl FnOnce(usize, (&mut [T], &mut [MaybeUninit<T>])),
    ) -> &mut [T] {
        unsafe {
            // fixme: ZST correctness isn't checked now,
            // it forbid growing, but allow `RawPlace::<ZST>::dangling` and thus `Alloc::<ZST>::new`'s
            const { assert!(mem::size_of::<T>() != 0) };

            // Manually compute the pointer to the uninitialized part (stable alternative to slice_ptr_get + ptr_as_uninit)
            let uninit_ptr = ptr.as_ptr().add(self.cap);
            let uninit_len = cap - self.cap;
            let uninit = slice::from_raw_parts_mut(uninit_ptr as *mut MaybeUninit<T>, uninit_len);

            self.ptr = ptr;
            self.cap = cap; // `ptr` and `cap` changes after panicking `fill`
            //                 ( alloc memory )

            // slice from `as_slice_mut` will be the initialized part of owned memory
            // while (&mut [T], &mut [MaybeUninit<T>]) will be the full memory
            fill(inited, (self.as_slice_mut(), uninit)); // panic out!

            self.len = cap; // `len` is same `cap` only if `uninit` was init

            crate::raw_mem::uninit::assume_init_mut(uninit)
        }
    }

    pub fn shrink_to(&mut self, cap: usize) {
        assert!(cap <= self.cap);

        unsafe {
            ptr::drop_in_place(&mut self.as_slice_mut()[cap..]);
        }

        self.cap = cap;
        self.len = cap;
    }

    pub fn set_ptr(&mut self, ptr: NonNull<[u8]>) {
        debug_assert_eq!(
            ptr.len(),
            self.cap * mem::size_of::<T>(),
            "Usually you have to call `.shrink_to` first to drop shrunk memory, \
             this should be followed by a call to `.set_ptr`."
        );

        self.ptr = ptr.cast();
    }
}

impl<T> fmt::Debug for RawPlace<T> {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        write!(f, "({:?}::{})", self.ptr, self.cap)
    }
}

unsafe impl<T: Sync> Sync for RawPlace<T> {}
unsafe impl<T: Send> Send for RawPlace<T> {}