alloc-traits 0.1.1

Traits to replace or supplement the alloc module in no_std
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

use core::ptr::NonNull;
use super::{Allocation, AllocTime, NonZeroLayout};

pub struct Global;

impl crate::LocalAlloc<'_> for Global {
    fn alloc(&self, layout: NonZeroLayout) -> Option<Allocation<'_>> {
        // SAFETY: the layout is not empty due to `NonZeroLayout`.
        let ptr = unsafe { alloc::alloc::alloc(layout.into()) };
        from_global_ptr(ptr, layout)
    }

    unsafe fn dealloc(&self, alloc: Allocation<'_>) {
        // SAFETY: all preconditions have been propagated.
        alloc::alloc::dealloc(alloc.ptr.as_ptr(), alloc.layout.into())
    }

    unsafe fn alloc_zeroed(&self, layout: NonZeroLayout)
        -> Option<Allocation<'_>> 
    {
        // SAFETY: the layout is not empty due to `NonZeroLayout`.
        let ptr = { alloc::alloc::alloc_zeroed(layout.into()) };
        from_global_ptr(ptr, layout)
    }

    unsafe fn realloc(&self, alloc: Allocation<'_>, layout: NonZeroLayout)
        -> Option<Allocation<'_>>
    {
        // We can't change the alignment, sadly.
        if layout.align() != alloc.layout.align() {
            return None;
        }

        // A new requirement that we did not propagate: We can not allow the new layout to overflow
        // if sized according to its alignment. That is, we should manually check the precondition.
        // For some reason this is not part of the original `alloc` requirements.
        let align_offset = usize::from(layout.size()).wrapping_neg() % layout.align();
        if usize::max_value() - align_offset < layout.size().into() {
            return None;
        }

        let ptr = alloc::alloc::realloc(
            alloc.ptr.as_ptr(),
            alloc.layout.into(),
            layout.size().into());

        from_global_ptr(ptr, layout)
    }
}

fn from_global_ptr<'any>(ptr: *mut u8, layout: NonZeroLayout) -> Option<Allocation<'any>> {
    let ptr = NonNull::new(ptr)?;
    Some(Allocation {
        ptr,
        layout: layout,
        lifetime: AllocTime::default(),
    })
}