src/libstd/alloc.rs

   1 //! Memory allocation APIs
   2 //!
   3 //! In a given program, the standard library has one “global” memory allocator
   4 //! that is used for example by `Box<T>` and `Vec<T>`.
   5 //!
   6 //! Currently the default global allocator is unspecified. Libraries, however,
   7 //! like `cdylib`s and `staticlib`s are guaranteed to use the [`System`] by
   8 //! default.
   9 //!
  10 //! [`System`]: struct.System.html
  11 //!
  12 //! # The `#[global_allocator]` attribute
  13 //!
  14 //! This attribute allows configuring the choice of global allocator.
  15 //! You can use this to implement a completely custom global allocator
  16 //! to route all default allocation requests to a custom object.
  17 //!
  18 //! ```rust
  19 //! use std::alloc::{GlobalAlloc, System, Layout};
  20 //!
  21 //! struct MyAllocator;
  22 //!
  23 //! unsafe impl GlobalAlloc for MyAllocator {
  24 //!     unsafe fn alloc(&self, layout: Layout) -> *mut u8 {
  25 //!         System.alloc(layout)
  26 //!     }
  27 //!
  28 //!     unsafe fn dealloc(&self, ptr: *mut u8, layout: Layout) {
  29 //!         System.dealloc(ptr, layout)
  30 //!     }
  31 //! }
  32 //!
  33 //! #[global_allocator]
  34 //! static GLOBAL: MyAllocator = MyAllocator;
  35 //!
  36 //! fn main() {
  37 //!     // This `Vec` will allocate memory through `GLOBAL` above
  38 //!     let mut v = Vec::new();
  39 //!     v.push(1);
  40 //! }
  41 //! ```
  42 //!
  43 //! The attribute is used on a `static` item whose type implements the
  44 //! [`GlobalAlloc`] trait. This type can be provided by an external library:
  45 //!
  46 //! [`GlobalAlloc`]: ../../core/alloc/trait.GlobalAlloc.html
  47 //!
  48 //! ```rust,ignore (demonstrates crates.io usage)
  49 //! extern crate jemallocator;
  50 //!
  51 //! use jemallocator::Jemalloc;
  52 //!
  53 //! #[global_allocator]
  54 //! static GLOBAL: Jemalloc = Jemalloc;
  55 //!
  56 //! fn main() {}
  57 //! ```
  58 //!
  59 //! The `#[global_allocator]` can only be used once in a crate
  60 //! or its recursive dependencies.
  61
  62 #![stable(feature = "alloc_module", since = "1.28.0")]
  63
  64 use core::sync::atomic::{AtomicPtr, Ordering};
  65 use core::{mem, ptr};
  66 use core::ptr::NonNull;
  67
  68 use crate::sys_common::util::dumb_print;
  69
  70 #[stable(feature = "alloc_module", since = "1.28.0")]
  71 #[doc(inline)]
  72 pub use alloc_crate::alloc::*;
  73
  74 /// The default memory allocator provided by the operating system.
  75 ///
  76 /// This is based on `malloc` on Unix platforms and `HeapAlloc` on Windows,
  77 /// plus related functions.
  78 ///
  79 /// This type implements the `GlobalAlloc` trait and Rust programs by default
  80 /// work as if they had this definition:
  81 ///
  82 /// ```rust
  83 /// use std::alloc::System;
  84 ///
  85 /// #[global_allocator]
  86 /// static A: System = System;
  87 ///
  88 /// fn main() {
  89 ///     let a = Box::new(4); // Allocates from the system allocator.
  90 ///     println!("{}", a);
  91 /// }
  92 /// ```
  93 ///
  94 /// You can also define your own wrapper around `System` if you'd like, such as
  95 /// keeping track of the number of all bytes allocated:
  96 ///
  97 /// ```rust
  98 /// use std::alloc::{System, GlobalAlloc, Layout};
  99 /// use std::sync::atomic::{AtomicUsize, Ordering::SeqCst};
 100 ///
 101 /// struct Counter;
 102 ///
 103 /// static ALLOCATED: AtomicUsize = AtomicUsize::new(0);
 104 ///
 105 /// unsafe impl GlobalAlloc for Counter {
 106 ///     unsafe fn alloc(&self, layout: Layout) -> *mut u8 {
 107 ///         let ret = System.alloc(layout);
 108 ///         if !ret.is_null() {
 109 ///             ALLOCATED.fetch_add(layout.size(), SeqCst);
 110 ///         }
 111 ///         return ret
 112 ///     }
 113 ///
 114 ///     unsafe fn dealloc(&self, ptr: *mut u8, layout: Layout) {
 115 ///         System.dealloc(ptr, layout);
 116 ///         ALLOCATED.fetch_sub(layout.size(), SeqCst);
 117 ///     }
 118 /// }
 119 ///
 120 /// #[global_allocator]
 121 /// static A: Counter = Counter;
 122 ///
 123 /// fn main() {
 124 ///     println!("allocated bytes before main: {}", ALLOCATED.load(SeqCst));
 125 /// }
 126 /// ```
 127 ///
 128 /// It can also be used directly to allocate memory independently of whatever
 129 /// global allocator has been selected for a Rust program. For example if a Rust
 130 /// program opts in to using jemalloc as the global allocator, `System` will
 131 /// still allocate memory using `malloc` and `HeapAlloc`.
 132 #[stable(feature = "alloc_system_type", since = "1.28.0")]
 133 #[derive(Debug, Default, Copy, Clone)]
 134 pub struct System;
 135
 136 // The Alloc impl just forwards to the GlobalAlloc impl, which is in `std::sys::*::alloc`.
 137 #[unstable(feature = "allocator_api", issue = "32838")]
 138 unsafe impl Alloc for System {
 139     #[inline]
 140     unsafe fn alloc(&mut self, layout: Layout) -> Result<NonNull<u8>, AllocErr> {
 141         NonNull::new(GlobalAlloc::alloc(self, layout)).ok_or(AllocErr)
 142     }
 143
 144     #[inline]
 145     unsafe fn alloc_zeroed(&mut self, layout: Layout) -> Result<NonNull<u8>, AllocErr> {
 146         NonNull::new(GlobalAlloc::alloc_zeroed(self, layout)).ok_or(AllocErr)
 147     }
 148
 149     #[inline]
 150     unsafe fn dealloc(&mut self, ptr: NonNull<u8>, layout: Layout) {
 151         GlobalAlloc::dealloc(self, ptr.as_ptr(), layout)
 152     }
 153
 154     #[inline]
 155     unsafe fn realloc(&mut self,
 156                       ptr: NonNull<u8>,
 157                       layout: Layout,
 158                       new_size: usize) -> Result<NonNull<u8>, AllocErr> {
 159         NonNull::new(GlobalAlloc::realloc(self, ptr.as_ptr(), layout, new_size)).ok_or(AllocErr)
 160     }
 161 }
 162
 163 static HOOK: AtomicPtr<()> = AtomicPtr::new(ptr::null_mut());
 164
 165 /// Registers a custom allocation error hook, replacing any that was previously registered.
 166 ///
 167 /// The allocation error hook is invoked when an infallible memory allocation fails, before
 168 /// the runtime aborts. The default hook prints a message to standard error,
 169 /// but this behavior can be customized with the [`set_alloc_error_hook`] and
 170 /// [`take_alloc_error_hook`] functions.
 171 ///
 172 /// The hook is provided with a `Layout` struct which contains information
 173 /// about the allocation that failed.
 174 ///
 175 /// The allocation error hook is a global resource.
 176 ///
 177 /// [`set_alloc_error_hook`]: fn.set_alloc_error_hook.html
 178 /// [`take_alloc_error_hook`]: fn.take_alloc_error_hook.html
 179 #[unstable(feature = "alloc_error_hook", issue = "51245")]
 180 pub fn set_alloc_error_hook(hook: fn(Layout)) {
 181     HOOK.store(hook as *mut (), Ordering::SeqCst);
 182 }
 183
 184 /// Unregisters the current allocation error hook, returning it.
 185 ///
 186 /// *See also the function [`set_alloc_error_hook`].*
 187 ///
 188 /// If no custom hook is registered, the default hook will be returned.
 189 ///
 190 /// [`set_alloc_error_hook`]: fn.set_alloc_error_hook.html
 191 #[unstable(feature = "alloc_error_hook", issue = "51245")]
 192 pub fn take_alloc_error_hook() -> fn(Layout) {
 193     let hook = HOOK.swap(ptr::null_mut(), Ordering::SeqCst);
 194     if hook.is_null() {
 195         default_alloc_error_hook
 196     } else {
 197         unsafe { mem::transmute(hook) }
 198     }
 199 }
 200
 201 fn default_alloc_error_hook(layout: Layout) {
 202     dumb_print(format_args!("memory allocation of {} bytes failed", layout.size()));
 203 }
 204
 205 #[cfg(not(test))]
 206 #[doc(hidden)]
 207 #[alloc_error_handler]
 208 #[unstable(feature = "alloc_internals", issue = "0")]
 209 pub fn rust_oom(layout: Layout) -> ! {
 210     let hook = HOOK.load(Ordering::SeqCst);
 211     let hook: fn(Layout) = if hook.is_null() {
 212         default_alloc_error_hook
 213     } else {
 214         unsafe { mem::transmute(hook) }
 215     };
 216     hook(layout);
 217     unsafe { crate::sys::abort_internal(); }
 218 }
 219
 220 #[cfg(not(test))]
 221 #[doc(hidden)]
 222 #[allow(unused_attributes)]
 223 #[unstable(feature = "alloc_internals", issue = "0")]
 224 pub mod __default_lib_allocator {
 225     use super::{System, Layout, GlobalAlloc};
 226     // These magic symbol names are used as a fallback for implementing the
 227     // `__rust_alloc` etc symbols (see `src/liballoc/alloc.rs) when there is
 228     // no `#[global_allocator]` attribute.
 229
 230     // for symbol names src/librustc/middle/allocator.rs
 231     // for signatures src/librustc_allocator/lib.rs
 232
 233     // linkage directives are provided as part of the current compiler allocator
 234     // ABI
 235
 236     #[rustc_std_internal_symbol]
 237     pub unsafe extern fn __rdl_alloc(size: usize, align: usize) -> *mut u8 {
 238         let layout = Layout::from_size_align_unchecked(size, align);
 239         System.alloc(layout)
 240     }
 241
 242     #[rustc_std_internal_symbol]
 243     pub unsafe extern fn __rdl_dealloc(ptr: *mut u8,
 244                                        size: usize,
 245                                        align: usize) {
 246         System.dealloc(ptr, Layout::from_size_align_unchecked(size, align))
 247     }
 248
 249     #[rustc_std_internal_symbol]
 250     pub unsafe extern fn __rdl_realloc(ptr: *mut u8,
 251                                        old_size: usize,
 252                                        align: usize,
 253                                        new_size: usize) -> *mut u8 {
 254         let old_layout = Layout::from_size_align_unchecked(old_size, align);
 255         System.realloc(ptr, old_layout, new_size)
 256     }
 257
 258     #[rustc_std_internal_symbol]
 259     pub unsafe extern fn __rdl_alloc_zeroed(size: usize, align: usize) -> *mut u8 {
 260         let layout = Layout::from_size_align_unchecked(size, align);
 261         System.alloc_zeroed(layout)
 262     }
 263 }