src/liballoc/alloc.rs

   1 //! Memory allocation APIs
   2
   3 #![stable(feature = "alloc_module", since = "1.28.0")]
   4
   5 use core::intrinsics::{min_align_of_val, size_of_val};
   6 use core::ptr::{NonNull, Unique};
   7 use core::usize;
   8
   9 #[stable(feature = "alloc_module", since = "1.28.0")]
  10 #[doc(inline)]
  11 pub use core::alloc::*;
  12
  13 #[cfg(test)]
  14 mod tests;
  15
  16 extern "Rust" {
  17     // These are the magic symbols to call the global allocator.  rustc generates
  18     // them from the `#[global_allocator]` attribute if there is one, or uses the
  19     // default implementations in libstd (`__rdl_alloc` etc in `src/libstd/alloc.rs`)
  20     // otherwise.
  21     #[rustc_allocator]
  22     #[rustc_allocator_nounwind]
  23     fn __rust_alloc(size: usize, align: usize) -> *mut u8;
  24     #[rustc_allocator_nounwind]
  25     fn __rust_dealloc(ptr: *mut u8, size: usize, align: usize);
  26     #[rustc_allocator_nounwind]
  27     fn __rust_realloc(ptr: *mut u8, old_size: usize, align: usize, new_size: usize) -> *mut u8;
  28     #[rustc_allocator_nounwind]
  29     fn __rust_alloc_zeroed(size: usize, align: usize) -> *mut u8;
  30 }
  31
  32 /// The global memory allocator.
  33 ///
  34 /// This type implements the [`AllocRef`] trait by forwarding calls
  35 /// to the allocator registered with the `#[global_allocator]` attribute
  36 /// if there is one, or the `std` crate’s default.
  37 ///
  38 /// Note: while this type is unstable, the functionality it provides can be
  39 /// accessed through the [free functions in `alloc`](index.html#functions).
  40 ///
  41 /// [`AllocRef`]: trait.AllocRef.html
  42 #[unstable(feature = "allocator_api", issue = "32838")]
  43 #[derive(Copy, Clone, Default, Debug)]
  44 pub struct Global;
  45
  46 /// Allocate memory with the global allocator.
  47 ///
  48 /// This function forwards calls to the [`GlobalAlloc::alloc`] method
  49 /// of the allocator registered with the `#[global_allocator]` attribute
  50 /// if there is one, or the `std` crate’s default.
  51 ///
  52 /// This function is expected to be deprecated in favor of the `alloc` method
  53 /// of the [`Global`] type when it and the [`AllocRef`] trait become stable.
  54 ///
  55 /// # Safety
  56 ///
  57 /// See [`GlobalAlloc::alloc`].
  58 ///
  59 /// [`Global`]: struct.Global.html
  60 /// [`AllocRef`]: trait.AllocRef.html
  61 /// [`GlobalAlloc::alloc`]: trait.GlobalAlloc.html#tymethod.alloc
  62 ///
  63 /// # Examples
  64 ///
  65 /// ```
  66 /// use std::alloc::{alloc, dealloc, Layout};
  67 ///
  68 /// unsafe {
  69 ///     let layout = Layout::new::<u16>();
  70 ///     let ptr = alloc(layout);
  71 ///
  72 ///     *(ptr as *mut u16) = 42;
  73 ///     assert_eq!(*(ptr as *mut u16), 42);
  74 ///
  75 ///     dealloc(ptr, layout);
  76 /// }
  77 /// ```
  78 #[stable(feature = "global_alloc", since = "1.28.0")]
  79 #[inline]
  80 pub unsafe fn alloc(layout: Layout) -> *mut u8 {
  81     __rust_alloc(layout.size(), layout.align())
  82 }
  83
  84 /// Deallocate memory with the global allocator.
  85 ///
  86 /// This function forwards calls to the [`GlobalAlloc::dealloc`] method
  87 /// of the allocator registered with the `#[global_allocator]` attribute
  88 /// if there is one, or the `std` crate’s default.
  89 ///
  90 /// This function is expected to be deprecated in favor of the `dealloc` method
  91 /// of the [`Global`] type when it and the [`AllocRef`] trait become stable.
  92 ///
  93 /// # Safety
  94 ///
  95 /// See [`GlobalAlloc::dealloc`].
  96 ///
  97 /// [`Global`]: struct.Global.html
  98 /// [`AllocRef`]: trait.AllocRef.html
  99 /// [`GlobalAlloc::dealloc`]: trait.GlobalAlloc.html#tymethod.dealloc
 100 #[stable(feature = "global_alloc", since = "1.28.0")]
 101 #[inline]
 102 pub unsafe fn dealloc(ptr: *mut u8, layout: Layout) {
 103     __rust_dealloc(ptr, layout.size(), layout.align())
 104 }
 105
 106 /// Reallocate memory with the global allocator.
 107 ///
 108 /// This function forwards calls to the [`GlobalAlloc::realloc`] method
 109 /// of the allocator registered with the `#[global_allocator]` attribute
 110 /// if there is one, or the `std` crate’s default.
 111 ///
 112 /// This function is expected to be deprecated in favor of the `realloc` method
 113 /// of the [`Global`] type when it and the [`AllocRef`] trait become stable.
 114 ///
 115 /// # Safety
 116 ///
 117 /// See [`GlobalAlloc::realloc`].
 118 ///
 119 /// [`Global`]: struct.Global.html
 120 /// [`AllocRef`]: trait.AllocRef.html
 121 /// [`GlobalAlloc::realloc`]: trait.GlobalAlloc.html#method.realloc
 122 #[stable(feature = "global_alloc", since = "1.28.0")]
 123 #[inline]
 124 pub unsafe fn realloc(ptr: *mut u8, layout: Layout, new_size: usize) -> *mut u8 {
 125     __rust_realloc(ptr, layout.size(), layout.align(), new_size)
 126 }
 127
 128 /// Allocate zero-initialized memory with the global allocator.
 129 ///
 130 /// This function forwards calls to the [`GlobalAlloc::alloc_zeroed`] method
 131 /// of the allocator registered with the `#[global_allocator]` attribute
 132 /// if there is one, or the `std` crate’s default.
 133 ///
 134 /// This function is expected to be deprecated in favor of the `alloc_zeroed` method
 135 /// of the [`Global`] type when it and the [`AllocRef`] trait become stable.
 136 ///
 137 /// # Safety
 138 ///
 139 /// See [`GlobalAlloc::alloc_zeroed`].
 140 ///
 141 /// [`Global`]: struct.Global.html
 142 /// [`AllocRef`]: trait.AllocRef.html
 143 /// [`GlobalAlloc::alloc_zeroed`]: trait.GlobalAlloc.html#method.alloc_zeroed
 144 ///
 145 /// # Examples
 146 ///
 147 /// ```
 148 /// use std::alloc::{alloc_zeroed, dealloc, Layout};
 149 ///
 150 /// unsafe {
 151 ///     let layout = Layout::new::<u16>();
 152 ///     let ptr = alloc_zeroed(layout);
 153 ///
 154 ///     assert_eq!(*(ptr as *mut u16), 0);
 155 ///
 156 ///     dealloc(ptr, layout);
 157 /// }
 158 /// ```
 159 #[stable(feature = "global_alloc", since = "1.28.0")]
 160 #[inline]
 161 pub unsafe fn alloc_zeroed(layout: Layout) -> *mut u8 {
 162     __rust_alloc_zeroed(layout.size(), layout.align())
 163 }
 164
 165 #[unstable(feature = "allocator_api", issue = "32838")]
 166 unsafe impl AllocRef for Global {
 167     #[inline]
 168     fn alloc(&mut self, layout: Layout) -> Result<(NonNull<u8>, usize), AllocErr> {
 169         if layout.size() == 0 {
 170             Ok((layout.dangling(), 0))
 171         } else {
 172             unsafe { NonNull::new(alloc(layout)).ok_or(AllocErr).map(|p| (p, layout.size())) }
 173         }
 174     }
 175
 176     #[inline]
 177     unsafe fn dealloc(&mut self, ptr: NonNull<u8>, layout: Layout) {
 178         if layout.size() != 0 {
 179             dealloc(ptr.as_ptr(), layout)
 180         }
 181     }
 182
 183     #[inline]
 184     unsafe fn realloc(
 185         &mut self,
 186         ptr: NonNull<u8>,
 187         layout: Layout,
 188         new_size: usize,
 189     ) -> Result<(NonNull<u8>, usize), AllocErr> {
 190         match (layout.size(), new_size) {
 191             (0, 0) => Ok((layout.dangling(), 0)),
 192             (0, _) => self.alloc(Layout::from_size_align_unchecked(new_size, layout.align())),
 193             (_, 0) => {
 194                 self.dealloc(ptr, layout);
 195                 Ok((layout.dangling(), 0))
 196             }
 197             (_, _) => NonNull::new(realloc(ptr.as_ptr(), layout, new_size))
 198                 .ok_or(AllocErr)
 199                 .map(|p| (p, new_size)),
 200         }
 201     }
 202
 203     #[inline]
 204     fn alloc_zeroed(&mut self, layout: Layout) -> Result<(NonNull<u8>, usize), AllocErr> {
 205         if layout.size() == 0 {
 206             Ok((layout.dangling(), 0))
 207         } else {
 208             unsafe {
 209                 NonNull::new(alloc_zeroed(layout)).ok_or(AllocErr).map(|p| (p, layout.size()))
 210             }
 211         }
 212     }
 213 }
 214
 215 /// The allocator for unique pointers.
 216 // This function must not unwind. If it does, MIR codegen will fail.
 217 #[cfg(not(test))]
 218 #[lang = "exchange_malloc"]
 219 #[inline]
 220 unsafe fn exchange_malloc(size: usize, align: usize) -> *mut u8 {
 221     if size == 0 {
 222         align as *mut u8
 223     } else {
 224         let layout = Layout::from_size_align_unchecked(size, align);
 225         match Global.alloc(layout) {
 226             Ok((ptr, _)) => ptr.as_ptr(),
 227             Err(_) => handle_alloc_error(layout),
 228         }
 229     }
 230 }
 231
 232 #[cfg_attr(not(test), lang = "box_free")]
 233 #[inline]
 234 // This signature has to be the same as `Box`, otherwise an ICE will happen.
 235 // When an additional parameter to `Box` is added (like `A: AllocRef`), this has to be added here as
 236 // well.
 237 // For example if `Box` is changed to  `struct Box<T: ?Sized, A: AllocRef>(Unique<T>, A)`,
 238 // this function has to be changed to `fn box_free<T: ?Sized, A: AllocRef>(Unique<T>, A)` as well.
 239 pub(crate) unsafe fn box_free<T: ?Sized>(ptr: Unique<T>) {
 240     let size = size_of_val(ptr.as_ref());
 241     let align = min_align_of_val(ptr.as_ref());
 242     // We do not allocate for Box<T> when T is ZST, so deallocation is also not necessary.
 243     if size != 0 {
 244         let layout = Layout::from_size_align_unchecked(size, align);
 245         Global.dealloc(ptr.cast().into(), layout);
 246     }
 247 }
 248
 249 /// Abort on memory allocation error or failure.
 250 ///
 251 /// Callers of memory allocation APIs wishing to abort computation
 252 /// in response to an allocation error are encouraged to call this function,
 253 /// rather than directly invoking `panic!` or similar.
 254 ///
 255 /// The default behavior of this function is to print a message to standard error
 256 /// and abort the process.
 257 /// It can be replaced with [`set_alloc_error_hook`] and [`take_alloc_error_hook`].
 258 ///
 259 /// [`set_alloc_error_hook`]: ../../std/alloc/fn.set_alloc_error_hook.html
 260 /// [`take_alloc_error_hook`]: ../../std/alloc/fn.take_alloc_error_hook.html
 261 #[stable(feature = "global_alloc", since = "1.28.0")]
 262 #[rustc_allocator_nounwind]
 263 pub fn handle_alloc_error(layout: Layout) -> ! {
 264     extern "Rust" {
 265         #[lang = "oom"]
 266         fn oom_impl(layout: Layout) -> !;
 267     }
 268     unsafe { oom_impl(layout) }
 269 }