src/liballoc/raw_vec.rs

   1 #![unstable(feature = "raw_vec_internals", reason = "implementation detail", issue = "none")]
   2 #![doc(hidden)]
   3
   4 use core::alloc::{LayoutErr, MemoryBlock};
   5 use core::cmp;
   6 use core::mem::{self, ManuallyDrop, MaybeUninit};
   7 use core::ops::Drop;
   8 use core::ptr::{NonNull, Unique};
   9 use core::slice;
  10
  11 use crate::alloc::{
  12     handle_alloc_error, AllocErr,
  13     AllocInit::{self, *},
  14     AllocRef, Global, Layout,
  15     ReallocPlacement::{self, *},
  16 };
  17 use crate::boxed::Box;
  18 use crate::collections::TryReserveError::{self, *};
  19
  20 #[cfg(test)]
  21 mod tests;
  22
  23 /// A low-level utility for more ergonomically allocating, reallocating, and deallocating
  24 /// a buffer of memory on the heap without having to worry about all the corner cases
  25 /// involved. This type is excellent for building your own data structures like Vec and VecDeque.
  26 /// In particular:
  27 ///
  28 /// * Produces `Unique::dangling()` on zero-sized types.
  29 /// * Produces `Unique::dangling()` on zero-length allocations.
  30 /// * Avoids freeing `Unique::dangling()`.
  31 /// * Catches all overflows in capacity computations (promotes them to "capacity overflow" panics).
  32 /// * Guards against 32-bit systems allocating more than isize::MAX bytes.
  33 /// * Guards against overflowing your length.
  34 /// * Calls `handle_alloc_error` for fallible allocations.
  35 /// * Contains a `ptr::Unique` and thus endows the user with all related benefits.
  36 /// * Uses the excess returned from the allocator to use the largest available capacity.
  37 ///
  38 /// This type does not in anyway inspect the memory that it manages. When dropped it *will*
  39 /// free its memory, but it *won't* try to drop its contents. It is up to the user of `RawVec`
  40 /// to handle the actual things *stored* inside of a `RawVec`.
  41 ///
  42 /// Note that the excess of a zero-sized types is always infinite, so `capacity()` always returns
  43 /// `usize::MAX`. This means that you need to be careful when round-tripping this type with a
  44 /// `Box<[T]>`, since `capacity()` won't yield the length.
  45 #[allow(missing_debug_implementations)]
  46 pub struct RawVec<T, A: AllocRef = Global> {
  47     ptr: Unique<T>,
  48     cap: usize,
  49     alloc: A,
  50 }
  51
  52 impl<T> RawVec<T, Global> {
  53     /// HACK(Centril): This exists because `#[unstable]` `const fn`s needn't conform
  54     /// to `min_const_fn` and so they cannot be called in `min_const_fn`s either.
  55     ///
  56     /// If you change `RawVec<T>::new` or dependencies, please take care to not
  57     /// introduce anything that would truly violate `min_const_fn`.
  58     ///
  59     /// NOTE: We could avoid this hack and check conformance with some
  60     /// `#[rustc_force_min_const_fn]` attribute which requires conformance
  61     /// with `min_const_fn` but does not necessarily allow calling it in
  62     /// `stable(...) const fn` / user code not enabling `foo` when
  63     /// `#[rustc_const_unstable(feature = "foo", ..)]` is present.
  64     pub const NEW: Self = Self::new();
  65
  66     /// Creates the biggest possible `RawVec` (on the system heap)
  67     /// without allocating. If `T` has positive size, then this makes a
  68     /// `RawVec` with capacity `0`. If `T` is zero-sized, then it makes a
  69     /// `RawVec` with capacity `usize::MAX`. Useful for implementing
  70     /// delayed allocation.
  71     pub const fn new() -> Self {
  72         Self::new_in(Global)
  73     }
  74
  75     /// Creates a `RawVec` (on the system heap) with exactly the
  76     /// capacity and alignment requirements for a `[T; capacity]`. This is
  77     /// equivalent to calling `RawVec::new` when `capacity` is `0` or `T` is
  78     /// zero-sized. Note that if `T` is zero-sized this means you will
  79     /// *not* get a `RawVec` with the requested capacity.
  80     ///
  81     /// # Panics
  82     ///
  83     /// * Panics if the requested capacity exceeds `usize::MAX` bytes.
  84     /// * Panics on 32-bit platforms if the requested capacity exceeds
  85     ///   `isize::MAX` bytes.
  86     ///
  87     /// # Aborts
  88     ///
  89     /// Aborts on OOM.
  90     #[inline]
  91     pub fn with_capacity(capacity: usize) -> Self {
  92         Self::with_capacity_in(capacity, Global)
  93     }
  94
  95     /// Like `with_capacity`, but guarantees the buffer is zeroed.
  96     #[inline]
  97     pub fn with_capacity_zeroed(capacity: usize) -> Self {
  98         Self::with_capacity_zeroed_in(capacity, Global)
  99     }
 100
 101     /// Reconstitutes a `RawVec` from a pointer and capacity.
 102     ///
 103     /// # Safety
 104     ///
 105     /// The `ptr` must be allocated (on the system heap), and with the given `capacity`.
 106     /// The `capacity` cannot exceed `isize::MAX` for sized types. (only a concern on 32-bit
 107     /// systems). ZST vectors may have a capacity up to `usize::MAX`.
 108     /// If the `ptr` and `capacity` come from a `RawVec`, then this is guaranteed.
 109     #[inline]
 110     pub unsafe fn from_raw_parts(ptr: *mut T, capacity: usize) -> Self {
 111         Self::from_raw_parts_in(ptr, capacity, Global)
 112     }
 113
 114     /// Converts a `Box<[T]>` into a `RawVec<T>`.
 115     pub fn from_box(slice: Box<[T]>) -> Self {
 116         unsafe {
 117             let mut slice = ManuallyDrop::new(slice);
 118             RawVec::from_raw_parts(slice.as_mut_ptr(), slice.len())
 119         }
 120     }
 121
 122     /// Converts the entire buffer into `Box<[MaybeUninit<T>]>` with the specified `len`.
 123     ///
 124     /// Note that this will correctly reconstitute any `cap` changes
 125     /// that may have been performed. (See description of type for details.)
 126     ///
 127     /// # Safety
 128     ///
 129     /// * `len` must be greater than or equal to the most recently requested capacity, and
 130     /// * `len` must be less than or equal to `self.capacity()`.
 131     ///
 132     /// Note, that the requested capacity and `self.capacity()` could differ, as
 133     /// an allocator could overallocate and return a greater memory block than requested.
 134     pub unsafe fn into_box(self, len: usize) -> Box<[MaybeUninit<T>]> {
 135         // Sanity-check one half of the safety requirement (we cannot check the other half).
 136         debug_assert!(
 137             len <= self.capacity(),
 138             "`len` must be smaller than or equal to `self.capacity()`"
 139         );
 140
 141         let me = ManuallyDrop::new(self);
 142         let slice = slice::from_raw_parts_mut(me.ptr() as *mut MaybeUninit<T>, len);
 143         Box::from_raw(slice)
 144     }
 145 }
 146
 147 impl<T, A: AllocRef> RawVec<T, A> {
 148     /// Like `new`, but parameterized over the choice of allocator for
 149     /// the returned `RawVec`.
 150     pub const fn new_in(alloc: A) -> Self {
 151         // `cap: 0` means "unallocated". zero-sized types are ignored.
 152         Self { ptr: Unique::dangling(), cap: 0, alloc }
 153     }
 154
 155     /// Like `with_capacity`, but parameterized over the choice of
 156     /// allocator for the returned `RawVec`.
 157     #[inline]
 158     pub fn with_capacity_in(capacity: usize, alloc: A) -> Self {
 159         Self::allocate_in(capacity, Uninitialized, alloc)
 160     }
 161
 162     /// Like `with_capacity_zeroed`, but parameterized over the choice
 163     /// of allocator for the returned `RawVec`.
 164     #[inline]
 165     pub fn with_capacity_zeroed_in(capacity: usize, alloc: A) -> Self {
 166         Self::allocate_in(capacity, Zeroed, alloc)
 167     }
 168
 169     fn allocate_in(capacity: usize, init: AllocInit, mut alloc: A) -> Self {
 170         if mem::size_of::<T>() == 0 {
 171             Self::new_in(alloc)
 172         } else {
 173             let layout = Layout::array::<T>(capacity).unwrap_or_else(|_| capacity_overflow());
 174             alloc_guard(layout.size()).unwrap_or_else(|_| capacity_overflow());
 175
 176             let memory = alloc.alloc(layout, init).unwrap_or_else(|_| handle_alloc_error(layout));
 177             Self {
 178                 ptr: unsafe { Unique::new_unchecked(memory.ptr.cast().as_ptr()) },
 179                 cap: Self::capacity_from_bytes(memory.size),
 180                 alloc,
 181             }
 182         }
 183     }
 184
 185     /// Reconstitutes a `RawVec` from a pointer, capacity, and allocator.
 186     ///
 187     /// # Safety
 188     ///
 189     /// The `ptr` must be allocated (via the given allocator `a`), and with the given `capacity`.
 190     /// The `capacity` cannot exceed `isize::MAX` for sized types. (only a concern on 32-bit
 191     /// systems). ZST vectors may have a capacity up to `usize::MAX`.
 192     /// If the `ptr` and `capacity` come from a `RawVec` created via `a`, then this is guaranteed.
 193     #[inline]
 194     pub unsafe fn from_raw_parts_in(ptr: *mut T, capacity: usize, a: A) -> Self {
 195         Self { ptr: Unique::new_unchecked(ptr), cap: capacity, alloc: a }
 196     }
 197
 198     /// Gets a raw pointer to the start of the allocation. Note that this is
 199     /// `Unique::dangling()` if `capacity == 0` or `T` is zero-sized. In the former case, you must
 200     /// be careful.
 201     pub fn ptr(&self) -> *mut T {
 202         self.ptr.as_ptr()
 203     }
 204
 205     /// Gets the capacity of the allocation.
 206     ///
 207     /// This will always be `usize::MAX` if `T` is zero-sized.
 208     #[inline(always)]
 209     pub fn capacity(&self) -> usize {
 210         if mem::size_of::<T>() == 0 { usize::MAX } else { self.cap }
 211     }
 212
 213     /// Returns a shared reference to the allocator backing this `RawVec`.
 214     pub fn alloc(&self) -> &A {
 215         &self.alloc
 216     }
 217
 218     /// Returns a mutable reference to the allocator backing this `RawVec`.
 219     pub fn alloc_mut(&mut self) -> &mut A {
 220         &mut self.alloc
 221     }
 222
 223     fn current_memory(&self) -> Option<(NonNull<u8>, Layout)> {
 224         if mem::size_of::<T>() == 0 || self.cap == 0 {
 225             None
 226         } else {
 227             // We have an allocated chunk of memory, so we can bypass runtime
 228             // checks to get our current layout.
 229             unsafe {
 230                 let align = mem::align_of::<T>();
 231                 let size = mem::size_of::<T>() * self.cap;
 232                 let layout = Layout::from_size_align_unchecked(size, align);
 233                 Some((self.ptr.cast().into(), layout))
 234             }
 235         }
 236     }
 237
 238     /// Ensures that the buffer contains at least enough space to hold
 239     /// `used_capacity + needed_extra_capacity` elements. If it doesn't already have
 240     /// enough capacity, will reallocate enough space plus comfortable slack
 241     /// space to get amortized `O(1)` behavior. Will limit this behavior
 242     /// if it would needlessly cause itself to panic.
 243     ///
 244     /// If `used_capacity` exceeds `self.capacity()`, this may fail to actually allocate
 245     /// the requested space. This is not really unsafe, but the unsafe
 246     /// code *you* write that relies on the behavior of this function may break.
 247     ///
 248     /// This is ideal for implementing a bulk-push operation like `extend`.
 249     ///
 250     /// # Panics
 251     ///
 252     /// * Panics if the requested capacity exceeds `usize::MAX` bytes.
 253     /// * Panics on 32-bit platforms if the requested capacity exceeds
 254     ///   `isize::MAX` bytes.
 255     ///
 256     /// # Aborts
 257     ///
 258     /// Aborts on OOM.
 259     ///
 260     /// # Examples
 261     ///
 262     /// ```
 263     /// # #![feature(raw_vec_internals)]
 264     /// # extern crate alloc;
 265     /// # use std::ptr;
 266     /// # use alloc::raw_vec::RawVec;
 267     /// struct MyVec<T> {
 268     ///     buf: RawVec<T>,
 269     ///     len: usize,
 270     /// }
 271     ///
 272     /// impl<T: Clone> MyVec<T> {
 273     ///     pub fn push_all(&mut self, elems: &[T]) {
 274     ///         self.buf.reserve(self.len, elems.len());
 275     ///         // reserve would have aborted or panicked if the len exceeded
 276     ///         // `isize::MAX` so this is safe to do unchecked now.
 277     ///         for x in elems {
 278     ///             unsafe {
 279     ///                 ptr::write(self.buf.ptr().add(self.len), x.clone());
 280     ///             }
 281     ///             self.len += 1;
 282     ///         }
 283     ///     }
 284     /// }
 285     /// # fn main() {
 286     /// #   let mut vector = MyVec { buf: RawVec::new(), len: 0 };
 287     /// #   vector.push_all(&[1, 3, 5, 7, 9]);
 288     /// # }
 289     /// ```
 290     pub fn reserve(&mut self, used_capacity: usize, needed_extra_capacity: usize) {
 291         match self.try_reserve(used_capacity, needed_extra_capacity) {
 292             Err(CapacityOverflow) => capacity_overflow(),
 293             Err(AllocError { layout, .. }) => handle_alloc_error(layout),
 294             Ok(()) => { /* yay */ }
 295         }
 296     }
 297
 298     /// The same as `reserve`, but returns on errors instead of panicking or aborting.
 299     pub fn try_reserve(
 300         &mut self,
 301         used_capacity: usize,
 302         needed_extra_capacity: usize,
 303     ) -> Result<(), TryReserveError> {
 304         if self.needs_to_grow(used_capacity, needed_extra_capacity) {
 305             self.grow_amortized(used_capacity, needed_extra_capacity, MayMove)
 306         } else {
 307             Ok(())
 308         }
 309     }
 310
 311     /// Attempts to ensure that the buffer contains at least enough space to hold
 312     /// `used_capacity + needed_extra_capacity` elements. If it doesn't already have
 313     /// enough capacity, will reallocate in place enough space plus comfortable slack
 314     /// space to get amortized `O(1)` behavior. Will limit this behaviour
 315     /// if it would needlessly cause itself to panic.
 316     ///
 317     /// If `used_capacity` exceeds `self.capacity()`, this may fail to actually allocate
 318     /// the requested space. This is not really unsafe, but the unsafe
 319     /// code *you* write that relies on the behavior of this function may break.
 320     ///
 321     /// Returns `true` if the reallocation attempt has succeeded.
 322     ///
 323     /// # Panics
 324     ///
 325     /// * Panics if the requested capacity exceeds `usize::MAX` bytes.
 326     /// * Panics on 32-bit platforms if the requested capacity exceeds
 327     ///   `isize::MAX` bytes.
 328     pub fn reserve_in_place(&mut self, used_capacity: usize, needed_extra_capacity: usize) -> bool {
 329         // This is more readable than putting this in one line:
 330         // `!self.needs_to_grow(...) || self.grow(...).is_ok()`
 331         if self.needs_to_grow(used_capacity, needed_extra_capacity) {
 332             self.grow_amortized(used_capacity, needed_extra_capacity, InPlace).is_ok()
 333         } else {
 334             true
 335         }
 336     }
 337
 338     /// Ensures that the buffer contains at least enough space to hold
 339     /// `used_capacity + needed_extra_capacity` elements. If it doesn't already,
 340     /// will reallocate the minimum possible amount of memory necessary.
 341     /// Generally this will be exactly the amount of memory necessary,
 342     /// but in principle the allocator is free to give back more than what
 343     /// we asked for.
 344     ///
 345     /// If `used_capacity` exceeds `self.capacity()`, this may fail to actually allocate
 346     /// the requested space. This is not really unsafe, but the unsafe
 347     /// code *you* write that relies on the behavior of this function may break.
 348     ///
 349     /// # Panics
 350     ///
 351     /// * Panics if the requested capacity exceeds `usize::MAX` bytes.
 352     /// * Panics on 32-bit platforms if the requested capacity exceeds
 353     ///   `isize::MAX` bytes.
 354     ///
 355     /// # Aborts
 356     ///
 357     /// Aborts on OOM.
 358     pub fn reserve_exact(&mut self, used_capacity: usize, needed_extra_capacity: usize) {
 359         match self.try_reserve_exact(used_capacity, needed_extra_capacity) {
 360             Err(CapacityOverflow) => capacity_overflow(),
 361             Err(AllocError { layout, .. }) => handle_alloc_error(layout),
 362             Ok(()) => { /* yay */ }
 363         }
 364     }
 365
 366     /// The same as `reserve_exact`, but returns on errors instead of panicking or aborting.
 367     pub fn try_reserve_exact(
 368         &mut self,
 369         used_capacity: usize,
 370         needed_extra_capacity: usize,
 371     ) -> Result<(), TryReserveError> {
 372         if self.needs_to_grow(used_capacity, needed_extra_capacity) {
 373             self.grow_exact(used_capacity, needed_extra_capacity)
 374         } else {
 375             Ok(())
 376         }
 377     }
 378
 379     /// Shrinks the allocation down to the specified amount. If the given amount
 380     /// is 0, actually completely deallocates.
 381     ///
 382     /// # Panics
 383     ///
 384     /// Panics if the given amount is *larger* than the current capacity.
 385     ///
 386     /// # Aborts
 387     ///
 388     /// Aborts on OOM.
 389     pub fn shrink_to_fit(&mut self, amount: usize) {
 390         match self.shrink(amount, MayMove) {
 391             Err(CapacityOverflow) => capacity_overflow(),
 392             Err(AllocError { layout, .. }) => handle_alloc_error(layout),
 393             Ok(()) => { /* yay */ }
 394         }
 395     }
 396 }
 397
 398 impl<T, A: AllocRef> RawVec<T, A> {
 399     /// Returns if the buffer needs to grow to fulfill the needed extra capacity.
 400     /// Mainly used to make inlining reserve-calls possible without inlining `grow`.
 401     fn needs_to_grow(&self, used_capacity: usize, needed_extra_capacity: usize) -> bool {
 402         needed_extra_capacity > self.capacity().wrapping_sub(used_capacity)
 403     }
 404
 405     fn capacity_from_bytes(excess: usize) -> usize {
 406         debug_assert_ne!(mem::size_of::<T>(), 0);
 407         excess / mem::size_of::<T>()
 408     }
 409
 410     fn set_memory(&mut self, memory: MemoryBlock) {
 411         self.ptr = unsafe { Unique::new_unchecked(memory.ptr.cast().as_ptr()) };
 412         self.cap = Self::capacity_from_bytes(memory.size);
 413     }
 414
 415     // This method is usually instantiated many times. So we want it to be as
 416     // small as possible, to improve compile times. But we also want as much of
 417     // its contents to be statically computable as possible, to make the
 418     // generated code run faster. Therefore, this method is carefully written
 419     // so that all of the code that depends on `T` is within it, while as much
 420     // of the code that doesn't depend on `T` as possible is in functions that
 421     // are non-generic over `T`.
 422     fn grow_amortized(
 423         &mut self,
 424         used_capacity: usize,
 425         needed_extra_capacity: usize,
 426         placement: ReallocPlacement,
 427     ) -> Result<(), TryReserveError> {
 428         // This is ensured by the calling contexts.
 429         debug_assert!(needed_extra_capacity > 0);
 430
 431         if mem::size_of::<T>() == 0 {
 432             // Since we return a capacity of `usize::MAX` when `elem_size` is
 433             // 0, getting to here necessarily means the `RawVec` is overfull.
 434             return Err(CapacityOverflow);
 435         }
 436
 437         // Nothing we can really do about these checks, sadly.
 438         let required_cap =
 439             used_capacity.checked_add(needed_extra_capacity).ok_or(CapacityOverflow)?;
 440
 441         // This guarantees exponential growth. The doubling cannot overflow
 442         // because `cap <= isize::MAX` and the type of `cap` is `usize`.
 443         let cap = cmp::max(self.cap * 2, required_cap);
 444
 445         // Tiny Vecs are dumb. Skip to:
 446         // - 8 if the element size is 1, because any heap allocators is likely
 447         //   to round up a request of less than 8 bytes to at least 8 bytes.
 448         // - 4 if elements are moderate-sized (<= 1 KiB).
 449         // - 1 otherwise, to avoid wasting too much space for very short Vecs.
 450         // Note that `min_non_zero_cap` is computed statically.
 451         let elem_size = mem::size_of::<T>();
 452         let min_non_zero_cap = if elem_size == 1 {
 453             8
 454         } else if elem_size <= 1024 {
 455             4
 456         } else {
 457             1
 458         };
 459         let cap = cmp::max(min_non_zero_cap, cap);
 460
 461         let new_layout = Layout::array::<T>(cap);
 462
 463         // `finish_grow` is non-generic over `T`.
 464         let memory = finish_grow(new_layout, placement, self.current_memory(), &mut self.alloc)?;
 465         self.set_memory(memory);
 466         Ok(())
 467     }
 468
 469     // The constraints on this method are much the same as those on
 470     // `grow_amortized`, but this method is usually instantiated less often so
 471     // it's less critical.
 472     fn grow_exact(
 473         &mut self,
 474         used_capacity: usize,
 475         needed_extra_capacity: usize,
 476     ) -> Result<(), TryReserveError> {
 477         if mem::size_of::<T>() == 0 {
 478             // Since we return a capacity of `usize::MAX` when the type size is
 479             // 0, getting to here necessarily means the `RawVec` is overfull.
 480             return Err(CapacityOverflow);
 481         }
 482
 483         let cap = used_capacity.checked_add(needed_extra_capacity).ok_or(CapacityOverflow)?;
 484         let new_layout = Layout::array::<T>(cap);
 485
 486         // `finish_grow` is non-generic over `T`.
 487         let memory = finish_grow(new_layout, MayMove, self.current_memory(), &mut self.alloc)?;
 488         self.set_memory(memory);
 489         Ok(())
 490     }
 491
 492     fn shrink(
 493         &mut self,
 494         amount: usize,
 495         placement: ReallocPlacement,
 496     ) -> Result<(), TryReserveError> {
 497         assert!(amount <= self.capacity(), "Tried to shrink to a larger capacity");
 498
 499         let (ptr, layout) = if let Some(mem) = self.current_memory() { mem } else { return Ok(()) };
 500         let new_size = amount * mem::size_of::<T>();
 501
 502         let memory = unsafe {
 503             self.alloc.shrink(ptr, layout, new_size, placement).map_err(|_| {
 504                 TryReserveError::AllocError {
 505                     layout: Layout::from_size_align_unchecked(new_size, layout.align()),
 506                     non_exhaustive: (),
 507                 }
 508             })?
 509         };
 510         self.set_memory(memory);
 511         Ok(())
 512     }
 513 }
 514
 515 // This function is outside `RawVec` to minimize compile times. See the comment
 516 // above `RawVec::grow_amortized` for details. (The `A` parameter isn't
 517 // significant, because the number of different `A` types seen in practice is
 518 // much smaller than the number of `T` types.)
 519 fn finish_grow<A>(
 520     new_layout: Result<Layout, LayoutErr>,
 521     placement: ReallocPlacement,
 522     current_memory: Option<(NonNull<u8>, Layout)>,
 523     alloc: &mut A,
 524 ) -> Result<MemoryBlock, TryReserveError>
 525 where
 526     A: AllocRef,
 527 {
 528     // Check for the error here to minimize the size of `RawVec::grow_*`.
 529     let new_layout = new_layout.map_err(|_| CapacityOverflow)?;
 530
 531     alloc_guard(new_layout.size())?;
 532
 533     let memory = if let Some((ptr, old_layout)) = current_memory {
 534         debug_assert_eq!(old_layout.align(), new_layout.align());
 535         unsafe { alloc.grow(ptr, old_layout, new_layout.size(), placement, Uninitialized) }
 536     } else {
 537         match placement {
 538             MayMove => alloc.alloc(new_layout, Uninitialized),
 539             InPlace => Err(AllocErr),
 540         }
 541     }
 542     .map_err(|_| AllocError { layout: new_layout, non_exhaustive: () })?;
 543
 544     Ok(memory)
 545 }
 546
 547 unsafe impl<#[may_dangle] T, A: AllocRef> Drop for RawVec<T, A> {
 548     /// Frees the memory owned by the `RawVec` *without* trying to drop its contents.
 549     fn drop(&mut self) {
 550         if let Some((ptr, layout)) = self.current_memory() {
 551             unsafe { self.alloc.dealloc(ptr, layout) }
 552         }
 553     }
 554 }
 555
 556 // We need to guarantee the following:
 557 // * We don't ever allocate `> isize::MAX` byte-size objects.
 558 // * We don't overflow `usize::MAX` and actually allocate too little.
 559 //
 560 // On 64-bit we just need to check for overflow since trying to allocate
 561 // `> isize::MAX` bytes will surely fail. On 32-bit and 16-bit we need to add
 562 // an extra guard for this in case we're running on a platform which can use
 563 // all 4GB in user-space, e.g., PAE or x32.
 564
 565 #[inline]
 566 fn alloc_guard(alloc_size: usize) -> Result<(), TryReserveError> {
 567     if mem::size_of::<usize>() < 8 && alloc_size > isize::MAX as usize {
 568         Err(CapacityOverflow)
 569     } else {
 570         Ok(())
 571     }
 572 }
 573
 574 // One central function responsible for reporting capacity overflows. This'll
 575 // ensure that the code generation related to these panics is minimal as there's
 576 // only one location which panics rather than a bunch throughout the module.
 577 fn capacity_overflow() -> ! {
 578     panic!("capacity overflow");
 579 }