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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
use crate::stack_req::StackReq;
use alloc::alloc::handle_alloc_error;
use alloc::alloc::Layout;
use core::mem::ManuallyDrop;
use core::mem::MaybeUninit;
use core::ptr::NonNull;

/// Buffer of uninitialized bytes to serve as workspace for dynamic arrays.
pub struct GlobalMemBuffer {
    ptr: NonNull<u8>,
    len: usize,
    align: usize,
}

/// Buffer of initialized bytes to serve as workspace for dynamic POD arrays.
pub struct GlobalPodBuffer {
    inner: GlobalMemBuffer,
}

impl GlobalPodBuffer {
    /// Allocate a memory buffer with sufficient storage for the given stack requirements, using the
    /// global allocator.
    ///
    /// Calls [`alloc::alloc::handle_alloc_error`] in the case of failure.
    ///
    /// # Example
    /// ```
    /// use dyn_stack::{PodStack, StackReq, GlobalPodBuffer};
    ///
    /// let req = StackReq::new::<i32>(3);
    /// let mut buf = GlobalPodBuffer::new(req);
    /// let stack = PodStack::new(&mut buf);
    ///
    /// // use the stack
    /// let (arr, _) = stack.make_with::<i32, _>(3, |i| i as i32);
    /// ```
    pub fn new(req: StackReq) -> Self {
        Self::try_new(req).unwrap_or_else(|_| handle_alloc_error(to_layout(req)))
    }

    /// Allocate a memory buffer with sufficient storage for the given stack requirements, using the
    /// global allocator, or an error if the allocation did not succeed.
    ///
    /// # Example
    /// ```
    /// use dyn_stack::{PodStack, StackReq, GlobalPodBuffer};
    ///
    /// let req = StackReq::try_new::<i32>(3).unwrap();
    /// let mut buf = GlobalPodBuffer::new(req);
    /// let stack = PodStack::new(&mut buf);
    ///
    /// // use the stack
    /// let (arr, _) = stack.make_with::<i32, _>(3, |i| i as i32);
    /// ```
    pub fn try_new(req: StackReq) -> Result<Self, AllocError> {
        unsafe {
            if req.size_bytes() == 0 {
                let ptr = core::ptr::null_mut::<u8>().wrapping_add(req.align_bytes());
                Ok(GlobalPodBuffer {
                    inner: GlobalMemBuffer {
                        ptr: NonNull::<u8>::new_unchecked(ptr),
                        len: 0,
                        align: req.align_bytes(),
                    },
                })
            } else {
                let layout = to_layout(req);
                let ptr = alloc::alloc::alloc_zeroed(layout);
                if ptr.is_null() {
                    return Err(AllocError);
                }
                let len = layout.size();
                let ptr = NonNull::<u8>::new_unchecked(ptr);
                Ok(GlobalPodBuffer {
                    inner: GlobalMemBuffer {
                        ptr,
                        len,
                        align: req.align_bytes(),
                    },
                })
            }
        }
    }

    /// Creates a [`GlobalPodBuffer`]	from its raw components.
    ///
    /// # Safety
    ///
    /// The arguments to this function must have been acquired from a call to
    /// [`GlobalPodBuffer::into_raw_parts`]
    #[inline]
    pub unsafe fn from_raw_parts(ptr: *mut u8, len: usize, align: usize) -> Self {
        GlobalPodBuffer {
            inner: GlobalMemBuffer {
                ptr: NonNull::new_unchecked(ptr),
                len,
                align,
            },
        }
    }

    /// Decomposes a [`GlobalPodBuffer`] into its raw components in this order: ptr, length and
    /// alignment.
    #[inline]
    pub fn into_raw_parts(self) -> (*mut u8, usize, usize) {
        let no_drop = ManuallyDrop::new(self);
        (
            no_drop.inner.ptr.as_ptr(),
            no_drop.inner.len,
            no_drop.inner.align,
        )
    }
}

impl GlobalMemBuffer {
    /// Allocate a memory buffer with sufficient storage for the given stack requirements, using the
    /// global allocator.
    ///
    /// Calls [`alloc::alloc::handle_alloc_error`] in the case of failure.
    ///
    /// # Example
    /// ```
    /// use dyn_stack::{DynStack, StackReq, GlobalMemBuffer};
    ///
    /// let req = StackReq::new::<i32>(3);
    /// let mut buf = GlobalMemBuffer::new(req);
    /// let stack = DynStack::new(&mut buf);
    ///
    /// // use the stack
    /// let (arr, _) = stack.make_with::<i32, _>(3, |i| i as i32);
    /// ```
    pub fn new(req: StackReq) -> Self {
        Self::try_new(req).unwrap_or_else(|_| handle_alloc_error(to_layout(req)))
    }

    /// Allocate a memory buffer with sufficient storage for the given stack requirements, using the
    /// global allocator, or an error if the allocation did not succeed.
    ///
    /// # Example
    /// ```
    /// use dyn_stack::{DynStack, StackReq, GlobalMemBuffer};
    ///
    /// let req = StackReq::try_new::<i32>(3).unwrap();
    /// let mut buf = GlobalMemBuffer::new(req);
    /// let stack = DynStack::new(&mut buf);
    ///
    /// // use the stack
    /// let (arr, _) = stack.make_with::<i32, _>(3, |i| i as i32);
    /// ```
    pub fn try_new(req: StackReq) -> Result<Self, AllocError> {
        unsafe {
            if req.size_bytes() == 0 {
                let ptr = core::ptr::null_mut::<u8>().wrapping_add(req.align_bytes());
                Ok(GlobalMemBuffer {
                    ptr: NonNull::<u8>::new_unchecked(ptr),
                    len: 0,
                    align: req.align_bytes(),
                })
            } else {
                let layout = to_layout(req);
                let ptr = alloc::alloc::alloc(layout);
                if ptr.is_null() {
                    return Err(AllocError);
                }
                let len = layout.size();
                let ptr = NonNull::<u8>::new_unchecked(ptr);
                Ok(GlobalMemBuffer {
                    ptr,
                    len,
                    align: req.align_bytes(),
                })
            }
        }
    }

    /// Creates a `GlobalMemBuffer`	from its raw components.
    ///
    /// # Safety
    ///
    /// The arguments to this function must have been acquired from a call to
    /// [`GlobalMemBuffer::into_raw_parts`]
    #[inline]
    pub unsafe fn from_raw_parts(ptr: *mut u8, len: usize, align: usize) -> Self {
        Self {
            ptr: NonNull::new_unchecked(ptr),
            len,
            align,
        }
    }

    /// Decomposes a `GlobalMemBuffer` into its raw components in this order: ptr, length and
    /// alignment.
    #[inline]
    pub fn into_raw_parts(self) -> (*mut u8, usize, usize) {
        let no_drop = ManuallyDrop::new(self);
        (no_drop.ptr.as_ptr(), no_drop.len, no_drop.align)
    }
}

unsafe impl Sync for GlobalMemBuffer {}
unsafe impl Send for GlobalMemBuffer {}

fn to_layout(req: StackReq) -> Layout {
    unsafe { Layout::from_size_align_unchecked(req.size_bytes(), req.align_bytes()) }
}

impl Drop for GlobalMemBuffer {
    #[inline]
    fn drop(&mut self) {
        unsafe {
            if self.len != 0 {
                alloc::alloc::dealloc(
                    self.ptr.as_ptr(),
                    Layout::from_size_align_unchecked(self.len, self.align),
                );
            }
        }
    }
}

impl core::ops::Deref for GlobalMemBuffer {
    type Target = [MaybeUninit<u8>];

    #[inline]
    fn deref(&self) -> &Self::Target {
        unsafe {
            core::slice::from_raw_parts(self.ptr.as_ptr() as *const MaybeUninit<u8>, self.len)
        }
    }
}

impl core::ops::DerefMut for GlobalMemBuffer {
    #[inline]
    fn deref_mut(&mut self) -> &mut Self::Target {
        unsafe {
            core::slice::from_raw_parts_mut(self.ptr.as_ptr() as *mut MaybeUninit<u8>, self.len)
        }
    }
}

impl core::ops::Deref for GlobalPodBuffer {
    type Target = [u8];

    #[inline]
    fn deref(&self) -> &Self::Target {
        unsafe { core::slice::from_raw_parts(self.inner.ptr.as_ptr(), self.inner.len) }
    }
}

impl core::ops::DerefMut for GlobalPodBuffer {
    #[inline]
    fn deref_mut(&mut self) -> &mut Self::Target {
        unsafe { core::slice::from_raw_parts_mut(self.inner.ptr.as_ptr(), self.inner.len) }
    }
}

/// Error during memory allocation.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct AllocError;

impl core::fmt::Display for AllocError {
    fn fmt(&self, fmt: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
        fmt.write_str("memory allocation failed")
    }
}

#[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
impl std::error::Error for AllocError {}

#[cfg(feature = "nightly")]
pub use nightly::*;

#[cfg(feature = "nightly")]
mod nightly {
    use super::*;
    use alloc::alloc::{Allocator, Global};

    #[cfg_attr(docsrs, doc(cfg(feature = "nightly")))]
    /// Buffer of uninitialized bytes to serve as workspace for dynamic arrays.
    pub struct MemBuffer<A: Allocator = Global> {
        ptr: NonNull<u8>,
        len: usize,
        align: usize,
        alloc: A,
    }

    unsafe impl<A: Allocator> Sync for MemBuffer<A> {}
    unsafe impl<A: Allocator> Send for MemBuffer<A> {}

    impl<A: Allocator> Drop for MemBuffer<A> {
        #[inline]
        fn drop(&mut self) {
            // SAFETY: this was initialized with std::alloc::alloc
            unsafe {
                self.alloc.deallocate(
                    self.ptr,
                    Layout::from_size_align_unchecked(self.len, self.align),
                )
            }
        }
    }

    impl<A: Allocator> MemBuffer<A> {
        /// Allocate a memory buffer with sufficient storage for the given stack requirements, using the
        /// provided allocator.
        ///
        /// Calls [`alloc::alloc::handle_alloc_error`] in the case of failure.
        ///
        /// # Example
        /// ```
        /// #![feature(allocator_api)]
        ///
        /// use dyn_stack::{DynStack, StackReq, MemBuffer};
        /// use std::alloc::Global;
        ///
        /// let req = StackReq::new::<i32>(3);
        /// let mut buf = MemBuffer::new(Global, req);
        /// let stack = DynStack::new(&mut buf);
        ///
        /// // use the stack
        /// let (arr, _) = stack.make_with::<i32, _>(3, |i| i as i32);
        /// ```
        pub fn new(alloc: A, req: StackReq) -> Self {
            Self::try_new(alloc, req).unwrap_or_else(|_| handle_alloc_error(to_layout(req)))
        }

        /// Allocate a memory buffer with sufficient storage for the given stack requirements, using the
        /// provided allocator, or an `AllocError` in the case of failure.
        ///
        /// # Example
        /// ```
        /// #![feature(allocator_api)]
        ///
        /// use dyn_stack::{DynStack, StackReq, MemBuffer};
        /// use std::alloc::Global;
        ///
        /// let req = StackReq::new::<i32>(3);
        /// let mut buf = MemBuffer::try_new(Global, req).unwrap();
        /// let stack = DynStack::new(&mut buf);
        ///
        /// // use the stack
        /// let (arr, _) = stack.make_with::<i32, _>(3, |i| i as i32);
        /// ```
        pub fn try_new(alloc: A, req: StackReq) -> Result<Self, AllocError> {
            unsafe {
                let ptr = &mut *(alloc
                    .allocate(to_layout(req))
                    .map_err(|_| AllocError)?
                    .as_ptr() as *mut [MaybeUninit<u8>]);
                let len = ptr.len();
                let ptr = NonNull::new_unchecked(ptr.as_mut_ptr() as *mut u8);
                Ok(MemBuffer {
                    alloc,
                    ptr,
                    len,
                    align: req.align_bytes(),
                })
            }
        }
    }

    impl<A: Allocator> core::ops::Deref for MemBuffer<A> {
        type Target = [MaybeUninit<u8>];

        #[inline]
        fn deref(&self) -> &Self::Target {
            unsafe {
                core::slice::from_raw_parts(self.ptr.as_ptr() as *const MaybeUninit<u8>, self.len)
            }
        }
    }

    impl<A: Allocator> core::ops::DerefMut for MemBuffer<A> {
        #[inline]
        fn deref_mut(&mut self) -> &mut Self::Target {
            unsafe {
                core::slice::from_raw_parts_mut(self.ptr.as_ptr() as *mut MaybeUninit<u8>, self.len)
            }
        }
    }
}