ialloc 0.0.0-2025-05-02

Allocator interface traits
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
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240

//! Macro implementation details.  These are supposed to be `#[doc(hidden)]` from view and not used directly.

pub mod prelude {
    pub use crate::{self as ialloc, Alignment, meta::Meta as _, bug, meta, thin, fat};

    pub use core::cfg;
    pub use core::prelude::rust_2021::*;
    pub use core::primitive::*;

    pub use core::alloc::{Layout, *}; // AllocError (unstable)
    pub use core::mem::MaybeUninit;
    pub use core::num::NonZeroUsize;
    pub use core::ptr::{NonNull, null_mut, slice_from_raw_parts_mut};

    pub fn dangling<T>(layout: Layout) -> NonNull<T> { crate::util::nn::dangling(layout) }
}

/// Implement [`ialloc`](crate) (and/or [`core`]) traits in terms of other traits
#[macro_export] macro_rules! impls {
    () => {};



    // unsafe impl core::alloc::{...} for {...} => ialloc::fat::{...};

    ( unsafe impl $([$($gdef:tt)*])? $(::)? core::alloc::GlobalAlloc for $ty:ty => $(::)? ialloc::fat::Realloc; $($tt:tt)* ) => {
        unsafe impl $(<$($gdef)*>)? ::core::alloc::GlobalAlloc for $ty {
            #[track_caller] unsafe fn alloc(&self, layout: ::core::alloc::Layout) -> *mut ::core::primitive::u8 {
                use $crate::_impls::prelude::*;
                fat::Alloc::alloc_uninit(self, layout).map_or(null_mut(), |p| p.as_ptr().cast())
            }

            #[track_caller] unsafe fn alloc_zeroed(&self, layout: ::core::alloc::Layout) -> *mut ::core::primitive::u8 {
                use $crate::_impls::prelude::*;
                fat::Alloc::alloc_zeroed(self, layout).map_or(null_mut(), |p| p.as_ptr().cast())
            }

            #[track_caller] unsafe fn dealloc(&self, ptr: *mut u8, layout: ::core::alloc::Layout) {
                use $crate::_impls::prelude::*;
                NonNull::new(ptr).map(|ptr| unsafe { fat::Free::free(self, ptr.cast(), layout) });
            }

            #[track_caller] unsafe fn realloc(&self, ptr: *mut u8, old_layout: ::core::alloc::Layout, new_size: ::core::primitive::usize) -> *mut ::core::primitive::u8 {
                use $crate::_impls::prelude::*;
                let Some(ptr) = NonNull::new(ptr) else { return null_mut() };
                let Ok(new_layout) = Layout::from_size_align(new_size, old_layout.align()) else { return null_mut() };
                unsafe { fat::Realloc::realloc_uninit(self, ptr.cast(), old_layout, new_layout) }.map_or(null_mut(), |p| p.as_ptr().cast())
            }
        }

        $crate::impls!($($tt)*);
    };

    ( unsafe impl $([$($gdef:tt)*])? $(::)? core::alloc::Allocator(unstable $(1.50$(.0)?)?) for $ty:ty => $(::)? ialloc::fat::Realloc; $($tt:tt)* ) => {
        unsafe impl $(<$($gdef)*>)? ::core::alloc::Allocator for $ty {
            #[track_caller] fn allocate(&self, layout: ::core::alloc::Layout) -> ::core::result::Result<::core::ptr::NonNull<[::core::primitive::u8]>, ::core::alloc::AllocError> {
                use $crate::_impls::prelude::*;
                let alloc = fat::Alloc::alloc_uninit(self, layout).map_err(|_| AllocError)?;
                NonNull::new(slice_from_raw_parts_mut(alloc.as_ptr().cast(), layout.size())).ok_or(AllocError)
            }

            #[track_caller] fn allocate_zeroed(&self, layout: ::core::alloc::Layout) -> ::core::result::Result<::core::ptr::NonNull<[::core::primitive::u8]>, ::core::alloc::AllocError> {
                use $crate::_impls::prelude::*;
                let alloc = fat::Alloc::alloc_zeroed(self, layout).map_err(|_| AllocError)?;
                NonNull::new(slice_from_raw_parts_mut(alloc.as_ptr().cast(), layout.size())).ok_or(AllocError)
            }

            #[track_caller] unsafe fn deallocate(&self, ptr: ::core::ptr::NonNull<::core::primitive::u8>, layout: ::core::alloc::Layout) {
                use $crate::_impls::prelude::*;
                unsafe { fat::Free::free(self, ptr.cast(), layout) }
            }

            #[track_caller] unsafe fn grow(&self, ptr: ::core::ptr::NonNull<::core::primitive::u8>, old_layout: ::core::alloc::Layout, new_layout: ::core::alloc::Layout) -> ::core::result::Result<::core::ptr::NonNull<[::core::primitive::u8]>, ::core::alloc::AllocError> {
                use $crate::_impls::prelude::*;
                let alloc = unsafe { fat::Realloc::realloc_uninit(self, ptr.cast(), old_layout, new_layout) }.map_err(|_| AllocError)?;
                NonNull::new(slice_from_raw_parts_mut(alloc.as_ptr().cast(), new_layout.size())).ok_or(AllocError)
            }

            #[track_caller] unsafe fn grow_zeroed(&self, ptr: ::core::ptr::NonNull<::core::primitive::u8>, old_layout: ::core::alloc::Layout, new_layout: ::core::alloc::Layout) -> ::core::result::Result<::core::ptr::NonNull<[::core::primitive::u8]>, ::core::alloc::AllocError> {
                use $crate::_impls::prelude::*;
                let alloc = unsafe { fat::Realloc::realloc_zeroed(self, ptr.cast(), old_layout, new_layout) }.map_err(|_| AllocError)?;
                NonNull::new(slice_from_raw_parts_mut(alloc.as_ptr().cast(), new_layout.size())).ok_or(AllocError)
            }

            #[track_caller] unsafe fn shrink(&self, ptr: ::core::ptr::NonNull<::core::primitive::u8>, old_layout: ::core::alloc::Layout, new_layout: ::core::alloc::Layout) -> ::core::result::Result<::core::ptr::NonNull<[::core::primitive::u8]>, ::core::alloc::AllocError> {
                use $crate::_impls::prelude::*;
                let alloc = unsafe { fat::Realloc::realloc_uninit(self, ptr.cast(), old_layout, new_layout) }.map_err(|_| AllocError)?;
                NonNull::new(slice_from_raw_parts_mut(alloc.as_ptr().cast(), new_layout.size())).ok_or(AllocError)
            }
        }

        $crate::impls!($($tt)*);
    };



    // unsafe impl ialloc::fat::{...} for {...} => ialloc::thin::{...};

    ( unsafe impl $([$($gdef:tt)*])? $(::)? ialloc::fat::Alloc for $ty:ty $(where [$($where:tt)*])? => $(::)? ialloc::thin::Alloc; $($tt:tt)* ) => {
        unsafe impl $(<$($gdef)*>)? $crate::fat::Alloc for $ty $(where $($where)*)? {
            fn alloc_uninit(&self, layout: ::core::alloc::Layout) -> ::core::result::Result<::core::ptr::NonNull<::core::mem::MaybeUninit<::core::primitive::u8>>, Self::Error> {
                use $crate::_impls::prelude::*;
                if layout.align() > Self::MAX_ALIGN.as_usize() { Err($crate::error::ExcessiveAlignmentRequestedError { requested: Alignment::new(layout.align()).unwrap_or(Alignment::MAX), supported: Self::MAX_ALIGN })? }
                $crate::thin::Alloc::alloc_uninit(self, layout.size())
            }
            fn alloc_zeroed(&self, layout: ::core::alloc::Layout) -> ::core::result::Result<::core::ptr::NonNull<::core::primitive::u8>, Self::Error> {
                use $crate::_impls::prelude::*;
                if layout.align() > Self::MAX_ALIGN.as_usize() { Err($crate::error::ExcessiveAlignmentRequestedError { requested: Alignment::new(layout.align()).unwrap_or(Alignment::MAX), supported: Self::MAX_ALIGN })? }
                $crate::thin::Alloc::alloc_zeroed(self, layout.size())
            }
        }
        $crate::impls!($($tt)*);
    };

    ( unsafe impl $([$($gdef:tt)*])? $(::)? ialloc::fat::Free for $ty:ty $(where [$($where:tt)*])? => $(::)? ialloc::thin::Free; $($tt:tt)* ) => {
        unsafe impl $(<$($gdef)*>)? $crate::fat::Free for $ty $(where $($where)*)? {
            unsafe fn free(&self, ptr: ::core::ptr::NonNull<::core::mem::MaybeUninit<::core::primitive::u8>>, layout: ::core::alloc::Layout) {
                use $crate::_impls::prelude::*;
                if cfg!(debug_assertions) && layout.align() > Self::MAX_ALIGN.as_usize() { bug::ub::invalid_free_align_for_allocator(layout.align()) }
                unsafe { $crate::thin::Free::free(self, ptr) }
            }
        }
        $crate::impls!($($tt)*);
    };

    ( unsafe impl $([$($gdef:tt)*])? $(::)? ialloc::fat::Realloc for $ty:ty $(where [$($where:tt)*])? => $(::)? ialloc::thin::Realloc; $($tt:tt)* ) => {
        unsafe impl $(<$($gdef)*>)? $crate::fat::Realloc for $ty $(where $($where)*)? {
            unsafe fn realloc_uninit(&self, ptr: ::core::ptr::NonNull<::core::mem::MaybeUninit<::core::primitive::u8>>, old_layout: ::core::alloc::Layout, new_layout: ::core::alloc::Layout) -> ::core::result::Result<::core::ptr::NonNull<::core::mem::MaybeUninit<::core::primitive::u8>>, Self::Error> {
                use $crate::_impls::prelude::*;
                if cfg!(debug_assertions) && old_layout.align() > Self::MAX_ALIGN.as_usize() { bug::ub::invalid_free_align_for_allocator(old_layout.align()) }
                if new_layout.align() > Self::MAX_ALIGN.as_usize() { Err($crate::error::ExcessiveAlignmentRequestedError { requested: Alignment::new(new_layout.align()).unwrap_or(Alignment::MAX), supported: Self::MAX_ALIGN })? }
                unsafe { $crate::thin::Realloc::realloc_uninit(self, ptr, new_layout.size()) }
            }
            unsafe fn realloc_zeroed(&self, ptr: ::core::ptr::NonNull<::core::mem::MaybeUninit<::core::primitive::u8>>, old_layout: ::core::alloc::Layout, new_layout: ::core::alloc::Layout) -> ::core::result::Result<::core::ptr::NonNull<::core::mem::MaybeUninit<::core::primitive::u8>>, Self::Error> {
                use $crate::_impls::prelude::*;
                if cfg!(debug_assertions) && old_layout.align() > Self::MAX_ALIGN.as_usize() { bug::ub::invalid_free_align_for_allocator(old_layout.align()) }
                if new_layout.align() > Self::MAX_ALIGN.as_usize() { Err($crate::error::ExcessiveAlignmentRequestedError { requested: Alignment::new(new_layout.align()).unwrap_or(Alignment::MAX), supported: Self::MAX_ALIGN })? }
                if <$ty as $crate::thin::Realloc>::CAN_REALLOC_ZEROED {
                    unsafe { $crate::thin::Realloc::realloc_zeroed(self, ptr, new_layout.size()) }
                } else {
                    let alloc = unsafe { $crate::thin::Realloc::realloc_uninit(self, ptr, new_layout.size())? };
                    if old_layout.size() < new_layout.size() {
                        let all             = unsafe { ::core::slice::from_raw_parts_mut(alloc.as_ptr(), new_layout.size()) };
                        let (_copied, new)  = all.split_at_mut(old_layout.size());
                        new.fill(MaybeUninit::new(0u8));
                    }
                    Ok(alloc.cast())
                }
            }
        }
        $crate::impls!($($tt)*);
    };



    // unsafe impl {...} for {...} => core::ops::Deref;

    ( unsafe impl $([$($gdef:tt)*])? $(::)? ialloc::thin::Alloc for $ty:ty => $(::)? core::ops::Deref; $($tt:tt)* ) => {
        unsafe impl $(<$($gdef)*>)? $crate::thin::Alloc for $ty {
            #[inline(always)] #[track_caller] fn alloc_uninit(&self, size: ::core::primitive::usize) -> ::core::result::Result<::core::ptr::NonNull<::core::mem::MaybeUninit<::core::primitive::u8>>, Self::Error> { $crate::thin::Alloc::alloc_uninit(&**self, size) }
            #[inline(always)] #[track_caller] fn alloc_zeroed(&self, size: ::core::primitive::usize) -> ::core::result::Result<::core::ptr::NonNull<                         ::core::primitive::u8 >, Self::Error> { $crate::thin::Alloc::alloc_zeroed(&**self, size) }
        }
        $crate::impls!($($tt)*);
    };

    ( unsafe impl $([$($gdef:tt)*])? $(::)? ialloc::thin::Free for $ty:ty => $(::)? core::ops::Deref; $($tt:tt)* ) => {
        unsafe impl $(<$($gdef)*>)? $crate::thin::Free for $ty {
            #[inline(always)] #[track_caller] unsafe fn free(&self, ptr: ::core::ptr::NonNull<::core::mem::MaybeUninit<::core::primitive::u8>>) { unsafe { $crate::thin::Free::free(&**self, ptr) } }
        }
        $crate::impls!($($tt)*);
    };

    ( unsafe impl $([$($gdef:tt)*])? $(::)? ialloc::thin::Realloc for $ty:ty => $(::)? core::ops::Deref; $($tt:tt)* ) => {
        unsafe impl $(<$($gdef)*>)? $crate::thin::Realloc for $ty {
            const CAN_REALLOC_ZEROED : ::core::primitive::bool = <<$ty as ::core::ops::Deref>::Target as $crate::thin::Realloc>::CAN_REALLOC_ZEROED;
            #[inline(always)] #[track_caller] unsafe fn realloc_uninit(&self, ptr: ::core::ptr::NonNull<::core::mem::MaybeUninit<::core::primitive::u8>>, new_size: ::core::primitive::usize) -> ::core::result::Result<::core::ptr::NonNull<::core::mem::MaybeUninit<::core::primitive::u8>>, Self::Error> { unsafe { $crate::thin::Realloc::realloc_uninit(&**self, ptr, new_size) } }
            #[inline(always)] #[track_caller] unsafe fn realloc_zeroed(&self, ptr: ::core::ptr::NonNull<::core::mem::MaybeUninit<::core::primitive::u8>>, new_size: ::core::primitive::usize) -> ::core::result::Result<::core::ptr::NonNull<::core::mem::MaybeUninit<::core::primitive::u8>>, Self::Error> { unsafe { $crate::thin::Realloc::realloc_zeroed(&**self, ptr, new_size) } }
        }
        $crate::impls!($($tt)*);
    };

    ( unsafe impl $([$($gdef:tt)*])? $(::)? ialloc::thin::SizeOf for $ty:ty => $(::)? core::ops::Deref; $($tt:tt)* ) => {
        unsafe impl $(<$($gdef)*>)? $crate::thin::SizeOf for $ty {
            #[inline(always)] #[track_caller] unsafe fn size_of(&self, ptr: ::core::ptr::NonNull<::core::mem::MaybeUninit<::core::primitive::u8>>) -> ::core::primitive::usize { unsafe { $crate::thin::SizeOf::size_of(&**self, ptr) } }
        }
        $crate::impls!($($tt)*);
    };

    ( unsafe impl $([$($gdef:tt)*])? $(::)? ialloc::thin::SizeOfDebug for $ty:ty => $(::)? core::ops::Deref; $($tt:tt)* ) => {
        unsafe impl $(<$($gdef)*>)? $crate::thin::SizeOfDebug for $ty {
            #[inline(always)] #[track_caller] unsafe fn size_of_debug(&self, ptr: ::core::ptr::NonNull<::core::mem::MaybeUninit<::core::primitive::u8>>) -> ::core::option::Option<::core::primitive::usize> { unsafe { $crate::thin::SizeOfDebug::size_of_debug(&**self, ptr) } }
        }
        $crate::impls!($($tt)*);
    };

    ( unsafe impl $([$($gdef:tt)*])? $(::)? ialloc::fat::Alloc for $ty:ty => $(::)? core::ops::Deref; $($tt:tt)* ) => {
        unsafe impl $(<$($gdef)*>)? $crate::fat::Alloc for $ty {
            #[inline(always)] #[track_caller] fn alloc_uninit(&self, layout: ::core::alloc::Layout) -> ::core::result::Result<::core::ptr::NonNull<::core::mem::MaybeUninit<::core::primitive::u8>>, Self::Error> { $crate::fat::Alloc::alloc_uninit(&**self, layout) }
            #[inline(always)] #[track_caller] fn alloc_zeroed(&self, layout: ::core::alloc::Layout) -> ::core::result::Result<::core::ptr::NonNull<                         ::core::primitive::u8 >, Self::Error> { $crate::fat::Alloc::alloc_zeroed(&**self, layout) }
        }
        $crate::impls!($($tt)*);
    };

    ( unsafe impl $([$($gdef:tt)*])? $(::)? ialloc::fat::Free for $ty:ty => $(::)? core::ops::Deref; $($tt:tt)* ) => {
        unsafe impl $(<$($gdef)*>)? $crate::fat::Free for $ty {
            #[inline(always)] #[track_caller] unsafe fn free(&self, ptr: ::core::ptr::NonNull<::core::mem::MaybeUninit<::core::primitive::u8>>, layout: ::core::alloc::Layout) { unsafe { $crate::fat::Free::free(&**self, ptr, layout) } }
        }
        $crate::impls!($($tt)*);
    };

    ( unsafe impl $([$($gdef:tt)*])? $(::)? ialloc::fat::Realloc for $ty:ty => $(::)? core::ops::Deref; $($tt:tt)* ) => {
        unsafe impl $(<$($gdef)*>)? $crate::fat::Realloc for $ty {
            #[inline(always)] #[track_caller] unsafe fn realloc_uninit(&self, ptr: ::core::ptr::NonNull<::core::mem::MaybeUninit<::core::primitive::u8>>, old_layout: ::core::alloc::Layout, new_layout: ::core::alloc::Layout) -> ::core::result::Result<::core::ptr::NonNull<::core::mem::MaybeUninit<::core::primitive::u8>>, Self::Error> { unsafe { $crate::fat::Realloc::realloc_uninit(&**self, ptr, old_layout, new_layout) } }
            #[inline(always)] #[track_caller] unsafe fn realloc_zeroed(&self, ptr: ::core::ptr::NonNull<::core::mem::MaybeUninit<::core::primitive::u8>>, old_layout: ::core::alloc::Layout, new_layout: ::core::alloc::Layout) -> ::core::result::Result<::core::ptr::NonNull<::core::mem::MaybeUninit<::core::primitive::u8>>, Self::Error> { unsafe { $crate::fat::Realloc::realloc_zeroed(&**self, ptr, old_layout, new_layout) } }
        }
        $crate::impls!($($tt)*);
    };

    ( unsafe impl $([$($gdef:tt)*])? $(::)? core::alloc::GlobalAlloc for $ty:ty => $(::)? core::ops::Deref; $($tt:tt)* ) => {
        unsafe impl $(<$($gdef)*>)? ::core::alloc::GlobalAlloc for $ty {
            #[inline(always)] #[track_caller] unsafe fn alloc           (&self, layout: ::core::alloc::Layout) -> *mut u8 { unsafe { ::core::alloc::GlobalAlloc::alloc(&**self, layout) } }
            #[inline(always)] #[track_caller] unsafe fn alloc_zeroed    (&self, layout: ::core::alloc::Layout) -> *mut u8 { unsafe { ::core::alloc::GlobalAlloc::alloc_zeroed(&**self, layout) } }
            #[inline(always)] #[track_caller] unsafe fn dealloc         (&self, ptr: *mut ::core::primitive::u8, layout: ::core::alloc::Layout) { unsafe { ::core::alloc::GlobalAlloc::dealloc(&**self, ptr, layout) } }
            #[inline(always)] #[track_caller] unsafe fn realloc         (&self, ptr: *mut ::core::primitive::u8, old_layout: ::core::alloc::Layout, new_size: ::core::primitive::usize) -> *mut u8 { unsafe { ::core::alloc::GlobalAlloc::realloc(&**self, ptr, old_layout, new_size) } }
        }
        $crate::impls!($($tt)*);
    };

    ( unsafe impl $([$($gdef:tt)*])? $(::)? core::alloc::Allocator(unstable $(1.50$(.0)?)?) for $ty:ty => $(::)? core::ops::Deref; $($tt:tt)* ) => {
        unsafe impl $(<$($gdef)*>)? ::core::alloc::Allocator for $ty {
            #[inline(always)] #[track_caller] fn allocate           (&self, layout: ::core::alloc::Layout) -> ::core::result::Result<::core::ptr::NonNull<[::core::primitive::u8]>, ::core::alloc::AllocError> { ::core::alloc::Allocator::allocate(&**self, layout) }
            #[inline(always)] #[track_caller] fn allocate_zeroed    (&self, layout: ::core::alloc::Layout) -> ::core::result::Result<::core::ptr::NonNull<[::core::primitive::u8]>, ::core::alloc::AllocError> { ::core::alloc::Allocator::allocate_zeroed(&**self, layout) }
            #[inline(always)] #[track_caller] unsafe fn deallocate  (&self, ptr: ::core::ptr::NonNull<u8>, layout: ::core::alloc::Layout) { unsafe { ::core::alloc::Allocator::deallocate(&**self, ptr, layout) } }
            #[inline(always)] #[track_caller] unsafe fn grow        (&self, ptr: ::core::ptr::NonNull<u8>, old_layout: ::core::alloc::Layout, new_layout: ::core::alloc::Layout) -> ::core::result::Result<::core::ptr::NonNull<[::core::primitive::u8]>, ::core::alloc::AllocError> { unsafe { ::core::alloc::Allocator::grow(&**self, ptr, old_layout, new_layout) } }
            #[inline(always)] #[track_caller] unsafe fn grow_zeroed (&self, ptr: ::core::ptr::NonNull<u8>, old_layout: ::core::alloc::Layout, new_layout: ::core::alloc::Layout) -> ::core::result::Result<::core::ptr::NonNull<[::core::primitive::u8]>, ::core::alloc::AllocError> { unsafe { ::core::alloc::Allocator::grow_zeroed(&**self, ptr, old_layout, new_layout) } }
            #[inline(always)] #[track_caller] unsafe fn shrink      (&self, ptr: ::core::ptr::NonNull<u8>, old_layout: ::core::alloc::Layout, new_layout: ::core::alloc::Layout) -> ::core::result::Result<::core::ptr::NonNull<[::core::primitive::u8]>, ::core::alloc::AllocError> { unsafe { ::core::alloc::Allocator::shrink(&**self, ptr, old_layout, new_layout) } }
        }
        $crate::impls!($($tt)*);
    };
}