<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source to the Rust file `libstd/alloc.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>alloc.rs.html -- source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico"></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../std/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span> <span id="2"> 2</span> <span id="3"> 3</span> <span id="4"> 4</span> <span id="5"> 5</span> <span id="6"> 6</span> <span id="7"> 7</span> <span id="8"> 8</span> <span id="9"> 9</span> <span id="10"> 10</span> <span id="11"> 11</span> <span id="12"> 12</span> <span id="13"> 13</span> <span id="14"> 14</span> <span id="15"> 15</span> <span id="16"> 16</span> <span id="17"> 17</span> <span id="18"> 18</span> <span id="19"> 19</span> <span id="20"> 20</span> <span id="21"> 21</span> <span id="22"> 22</span> <span id="23"> 23</span> <span id="24"> 24</span> <span id="25"> 25</span> <span id="26"> 26</span> <span id="27"> 27</span> <span id="28"> 28</span> <span id="29"> 29</span> <span id="30"> 30</span> <span id="31"> 31</span> <span id="32"> 32</span> <span id="33"> 33</span> <span id="34"> 34</span> <span id="35"> 35</span> <span id="36"> 36</span> <span id="37"> 37</span> <span id="38"> 38</span> <span id="39"> 39</span> <span id="40"> 40</span> <span id="41"> 41</span> <span id="42"> 42</span> <span id="43"> 43</span> <span id="44"> 44</span> <span id="45"> 45</span> <span id="46"> 46</span> <span id="47"> 47</span> <span id="48"> 48</span> <span id="49"> 49</span> <span id="50"> 50</span> <span id="51"> 51</span> <span id="52"> 52</span> <span id="53"> 53</span> <span id="54"> 54</span> <span id="55"> 55</span> <span id="56"> 56</span> <span id="57"> 57</span> <span id="58"> 58</span> <span id="59"> 59</span> <span id="60"> 60</span> <span id="61"> 61</span> <span id="62"> 62</span> <span id="63"> 63</span> <span id="64"> 64</span> <span id="65"> 65</span> <span id="66"> 66</span> <span id="67"> 67</span> <span id="68"> 68</span> <span id="69"> 69</span> <span id="70"> 70</span> <span id="71"> 71</span> <span id="72"> 72</span> <span id="73"> 73</span> <span id="74"> 74</span> <span id="75"> 75</span> <span id="76"> 76</span> <span id="77"> 77</span> <span id="78"> 78</span> <span id="79"> 79</span> <span id="80"> 80</span> <span id="81"> 81</span> <span id="82"> 82</span> <span id="83"> 83</span> <span id="84"> 84</span> <span id="85"> 85</span> <span id="86"> 86</span> <span id="87"> 87</span> <span id="88"> 88</span> <span id="89"> 89</span> <span id="90"> 90</span> <span id="91"> 91</span> <span id="92"> 92</span> <span id="93"> 93</span> <span id="94"> 94</span> <span id="95"> 95</span> <span id="96"> 96</span> <span id="97"> 97</span> <span id="98"> 98</span> <span id="99"> 99</span> <span id="100">100</span> <span id="101">101</span> <span id="102">102</span> <span id="103">103</span> <span id="104">104</span> <span id="105">105</span> <span id="106">106</span> <span id="107">107</span> <span id="108">108</span> <span id="109">109</span> <span id="110">110</span> <span id="111">111</span> <span id="112">112</span> <span id="113">113</span> <span id="114">114</span> <span id="115">115</span> <span id="116">116</span> <span id="117">117</span> <span id="118">118</span> <span id="119">119</span> <span id="120">120</span> <span id="121">121</span> <span id="122">122</span> <span id="123">123</span> <span id="124">124</span> <span id="125">125</span> <span id="126">126</span> <span id="127">127</span> <span id="128">128</span> <span id="129">129</span> <span id="130">130</span> <span id="131">131</span> <span id="132">132</span> <span id="133">133</span> <span id="134">134</span> <span id="135">135</span> <span id="136">136</span> <span id="137">137</span> <span id="138">138</span> <span id="139">139</span> <span id="140">140</span> <span id="141">141</span> <span id="142">142</span> <span id="143">143</span> <span id="144">144</span> <span id="145">145</span> <span id="146">146</span> <span id="147">147</span> <span id="148">148</span> <span id="149">149</span> <span id="150">150</span> <span id="151">151</span> <span id="152">152</span> <span id="153">153</span> <span id="154">154</span> <span id="155">155</span> <span id="156">156</span> <span id="157">157</span> <span id="158">158</span> <span id="159">159</span> <span id="160">160</span> <span id="161">161</span> <span id="162">162</span> <span id="163">163</span> <span id="164">164</span> <span id="165">165</span> <span id="166">166</span> <span id="167">167</span> <span id="168">168</span> <span id="169">169</span> <span id="170">170</span> <span id="171">171</span> <span id="172">172</span> <span id="173">173</span> <span id="174">174</span> <span id="175">175</span> <span id="176">176</span> <span id="177">177</span> <span id="178">178</span> <span id="179">179</span> <span id="180">180</span> <span id="181">181</span> <span id="182">182</span> <span id="183">183</span> <span id="184">184</span> </pre><pre class="rust "> <span class="comment">// Copyright 2017 The Rust Project Developers. See the COPYRIGHT</span> <span class="comment">// file at the top-level directory of this distribution and at</span> <span class="comment">// http://rust-lang.org/COPYRIGHT.</span> <span class="comment">//</span> <span class="comment">// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license</span> <span class="comment">// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your</span> <span class="comment">// option. This file may not be copied, modified, or distributed</span> <span class="comment">// except according to those terms.</span> <span class="doccomment">//! Memory allocation APIs</span> <span class="doccomment">//!</span> <span class="doccomment">//! In a given program, the standard library has one “global” memory allocator</span> <span class="doccomment">//! that is used for example by `Box<T>` and `Vec<T>`.</span> <span class="doccomment">//!</span> <span class="doccomment">//! Currently the default global allocator is unspecified.</span> <span class="doccomment">//! The compiler may link to a version of [jemalloc] on some platforms,</span> <span class="doccomment">//! but this is not guaranteed.</span> <span class="doccomment">//! Libraries, however, like `cdylib`s and `staticlib`s are guaranteed</span> <span class="doccomment">//! to use the [`System`] by default.</span> <span class="doccomment">//!</span> <span class="doccomment">//! [jemalloc]: https://github.com/jemalloc/jemalloc</span> <span class="doccomment">//! [`System`]: struct.System.html</span> <span class="doccomment">//!</span> <span class="doccomment">//! # The `#[global_allocator]` attribute</span> <span class="doccomment">//!</span> <span class="doccomment">//! This attribute allows configuring the choice of global allocator.</span> <span class="doccomment">//! You can use this to implement a completely custom global allocator</span> <span class="doccomment">//! to route all default allocation requests to a custom object.</span> <span class="doccomment">//!</span> <span class="doccomment">//! ```rust</span> <span class="doccomment">//! use std::alloc::{GlobalAlloc, System, Layout};</span> <span class="doccomment">//!</span> <span class="doccomment">//! struct MyAllocator;</span> <span class="doccomment">//!</span> <span class="doccomment">//! unsafe impl GlobalAlloc for MyAllocator {</span> <span class="doccomment">//! unsafe fn alloc(&self, layout: Layout) -> *mut u8 {</span> <span class="doccomment">//! System.alloc(layout)</span> <span class="doccomment">//! }</span> <span class="doccomment">//!</span> <span class="doccomment">//! unsafe fn dealloc(&self, ptr: *mut u8, layout: Layout) {</span> <span class="doccomment">//! System.dealloc(ptr, layout)</span> <span class="doccomment">//! }</span> <span class="doccomment">//! }</span> <span class="doccomment">//!</span> <span class="doccomment">//! #[global_allocator]</span> <span class="doccomment">//! static GLOBAL: MyAllocator = MyAllocator;</span> <span class="doccomment">//!</span> <span class="doccomment">//! fn main() {</span> <span class="doccomment">//! // This `Vec` will allocate memory through `GLOBAL` above</span> <span class="doccomment">//! let mut v = Vec::new();</span> <span class="doccomment">//! v.push(1);</span> <span class="doccomment">//! }</span> <span class="doccomment">//! ```</span> <span class="doccomment">//!</span> <span class="doccomment">//! The attribute is used on a `static` item whose type implements the</span> <span class="doccomment">//! [`GlobalAlloc`] trait. This type can be provided by an external library:</span> <span class="doccomment">//!</span> <span class="doccomment">//! [`GlobalAlloc`]: ../../core/alloc/trait.GlobalAlloc.html</span> <span class="doccomment">//!</span> <span class="doccomment">//! ```rust,ignore (demonstrates crates.io usage)</span> <span class="doccomment">//! extern crate jemallocator;</span> <span class="doccomment">//!</span> <span class="doccomment">//! use jemallacator::Jemalloc;</span> <span class="doccomment">//!</span> <span class="doccomment">//! #[global_allocator]</span> <span class="doccomment">//! static GLOBAL: Jemalloc = Jemalloc;</span> <span class="doccomment">//!</span> <span class="doccomment">//! fn main() {}</span> <span class="doccomment">//! ```</span> <span class="doccomment">//!</span> <span class="doccomment">//! The `#[global_allocator]` can only be used once in a crate</span> <span class="doccomment">//! or its recursive dependencies.</span> <span class="attribute">#![<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"alloc_module"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.28.0"</span>)]</span> <span class="kw">use</span> <span class="ident">core</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicPtr</span>, <span class="ident">Ordering</span>}; <span class="kw">use</span> <span class="ident">core</span>::{<span class="ident">mem</span>, <span class="ident">ptr</span>}; <span class="kw">use</span> <span class="ident">sys_common</span>::<span class="ident">util</span>::<span class="ident">dumb_print</span>; <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"alloc_module"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.28.0"</span>)]</span> <span class="attribute">#[<span class="ident">doc</span>(<span class="ident">inline</span>)]</span> <span class="kw">pub</span> <span class="kw">use</span> <span class="ident">alloc_crate</span>::<span class="ident">alloc</span>::<span class="kw-2">*</span>; <span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"alloc_system_type"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.28.0"</span>)]</span> <span class="attribute">#[<span class="ident">doc</span>(<span class="ident">inline</span>)]</span> <span class="kw">pub</span> <span class="kw">use</span> <span class="ident">alloc_system</span>::<span class="ident">System</span>; <span class="kw">static</span> <span class="ident">HOOK</span>: <span class="ident">AtomicPtr</span><span class="op"><</span>()<span class="op">></span> <span class="op">=</span> <span class="ident">AtomicPtr</span>::<span class="ident">new</span>(<span class="ident">ptr</span>::<span class="ident">null_mut</span>()); <span class="doccomment">/// Registers a custom allocation error hook, replacing any that was previously registered.</span> <span class="doccomment">///</span> <span class="doccomment">/// The allocation error hook is invoked when an infallible memory allocation fails, before</span> <span class="doccomment">/// the runtime aborts. The default hook prints a message to standard error,</span> <span class="doccomment">/// but this behavior can be customized with the [`set_alloc_error_hook`] and</span> <span class="doccomment">/// [`take_alloc_error_hook`] functions.</span> <span class="doccomment">///</span> <span class="doccomment">/// The hook is provided with a `Layout` struct which contains information</span> <span class="doccomment">/// about the allocation that failed.</span> <span class="doccomment">///</span> <span class="doccomment">/// The allocation error hook is a global resource.</span> <span class="attribute">#[<span class="ident">unstable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"alloc_error_hook"</span>, <span class="ident">issue</span> <span class="op">=</span> <span class="string">"51245"</span>)]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_alloc_error_hook</span>(<span class="ident">hook</span>: <span class="kw">fn</span>(<span class="ident">Layout</span>)) { <span class="ident">HOOK</span>.<span class="ident">store</span>(<span class="ident">hook</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> (), <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>); } <span class="doccomment">/// Unregisters the current allocation error hook, returning it.</span> <span class="doccomment">///</span> <span class="doccomment">/// *See also the function [`set_alloc_error_hook`].*</span> <span class="doccomment">///</span> <span class="doccomment">/// If no custom hook is registered, the default hook will be returned.</span> <span class="attribute">#[<span class="ident">unstable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"alloc_error_hook"</span>, <span class="ident">issue</span> <span class="op">=</span> <span class="string">"51245"</span>)]</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">take_alloc_error_hook</span>() <span class="op">-></span> <span class="kw">fn</span>(<span class="ident">Layout</span>) { <span class="kw">let</span> <span class="ident">hook</span> <span class="op">=</span> <span class="ident">HOOK</span>.<span class="ident">swap</span>(<span class="ident">ptr</span>::<span class="ident">null_mut</span>(), <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>); <span class="kw">if</span> <span class="ident">hook</span>.<span class="ident">is_null</span>() { <span class="ident">default_alloc_error_hook</span> } <span class="kw">else</span> { <span class="kw">unsafe</span> { <span class="ident">mem</span>::<span class="ident">transmute</span>(<span class="ident">hook</span>) } } } <span class="kw">fn</span> <span class="ident">default_alloc_error_hook</span>(<span class="ident">layout</span>: <span class="ident">Layout</span>) { <span class="ident">dumb_print</span>(<span class="macro">format_args</span><span class="macro">!</span>(<span class="string">"memory allocation of {} bytes failed"</span>, <span class="ident">layout</span>.<span class="ident">size</span>())); } <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">test</span>))]</span> <span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span> <span class="attribute">#[<span class="ident">lang</span> <span class="op">=</span> <span class="string">"oom"</span>]</span> <span class="attribute">#[<span class="ident">unstable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"alloc_internals"</span>, <span class="ident">issue</span> <span class="op">=</span> <span class="string">"0"</span>)]</span> <span class="kw">pub</span> <span class="kw">extern</span> <span class="kw">fn</span> <span class="ident">rust_oom</span>(<span class="ident">layout</span>: <span class="ident">Layout</span>) <span class="op">-></span> <span class="op">!</span> { <span class="kw">let</span> <span class="ident">hook</span> <span class="op">=</span> <span class="ident">HOOK</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">SeqCst</span>); <span class="kw">let</span> <span class="ident">hook</span>: <span class="kw">fn</span>(<span class="ident">Layout</span>) <span class="op">=</span> <span class="kw">if</span> <span class="ident">hook</span>.<span class="ident">is_null</span>() { <span class="ident">default_alloc_error_hook</span> } <span class="kw">else</span> { <span class="kw">unsafe</span> { <span class="ident">mem</span>::<span class="ident">transmute</span>(<span class="ident">hook</span>) } }; <span class="ident">hook</span>(<span class="ident">layout</span>); <span class="kw">unsafe</span> { ::<span class="ident">sys</span>::<span class="ident">abort_internal</span>(); } } <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">test</span>))]</span> <span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span> <span class="attribute">#[<span class="ident">allow</span>(<span class="ident">unused_attributes</span>)]</span> <span class="attribute">#[<span class="ident">unstable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"alloc_internals"</span>, <span class="ident">issue</span> <span class="op">=</span> <span class="string">"0"</span>)]</span> <span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">__default_lib_allocator</span> { <span class="kw">use</span> <span class="kw">super</span>::{<span class="ident">System</span>, <span class="ident">Layout</span>, <span class="ident">GlobalAlloc</span>}; <span class="comment">// for symbol names src/librustc/middle/allocator.rs</span> <span class="comment">// for signatures src/librustc_allocator/lib.rs</span> <span class="comment">// linkage directives are provided as part of the current compiler allocator</span> <span class="comment">// ABI</span> <span class="attribute">#[<span class="ident">no_mangle</span>]</span> <span class="attribute">#[<span class="ident">rustc_std_internal_symbol</span>]</span> <span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">extern</span> <span class="kw">fn</span> <span class="ident">__rdl_alloc</span>(<span class="ident">size</span>: <span class="ident">usize</span>, <span class="ident">align</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">u8</span> { <span class="kw">let</span> <span class="ident">layout</span> <span class="op">=</span> <span class="ident">Layout</span>::<span class="ident">from_size_align_unchecked</span>(<span class="ident">size</span>, <span class="ident">align</span>); <span class="ident">System</span>.<span class="ident">alloc</span>(<span class="ident">layout</span>) } <span class="attribute">#[<span class="ident">no_mangle</span>]</span> <span class="attribute">#[<span class="ident">rustc_std_internal_symbol</span>]</span> <span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">extern</span> <span class="kw">fn</span> <span class="ident">__rdl_dealloc</span>(<span class="ident">ptr</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">u8</span>, <span class="ident">size</span>: <span class="ident">usize</span>, <span class="ident">align</span>: <span class="ident">usize</span>) { <span class="ident">System</span>.<span class="ident">dealloc</span>(<span class="ident">ptr</span>, <span class="ident">Layout</span>::<span class="ident">from_size_align_unchecked</span>(<span class="ident">size</span>, <span class="ident">align</span>)) } <span class="attribute">#[<span class="ident">no_mangle</span>]</span> <span class="attribute">#[<span class="ident">rustc_std_internal_symbol</span>]</span> <span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">extern</span> <span class="kw">fn</span> <span class="ident">__rdl_realloc</span>(<span class="ident">ptr</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">u8</span>, <span class="ident">old_size</span>: <span class="ident">usize</span>, <span class="ident">align</span>: <span class="ident">usize</span>, <span class="ident">new_size</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">u8</span> { <span class="kw">let</span> <span class="ident">old_layout</span> <span class="op">=</span> <span class="ident">Layout</span>::<span class="ident">from_size_align_unchecked</span>(<span class="ident">old_size</span>, <span class="ident">align</span>); <span class="ident">System</span>.<span class="ident">realloc</span>(<span class="ident">ptr</span>, <span class="ident">old_layout</span>, <span class="ident">new_size</span>) } <span class="attribute">#[<span class="ident">no_mangle</span>]</span> <span class="attribute">#[<span class="ident">rustc_std_internal_symbol</span>]</span> <span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">extern</span> <span class="kw">fn</span> <span class="ident">__rdl_alloc_zeroed</span>(<span class="ident">size</span>: <span class="ident">usize</span>, <span class="ident">align</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">u8</span> { <span class="kw">let</span> <span class="ident">layout</span> <span class="op">=</span> <span class="ident">Layout</span>::<span class="ident">from_size_align_unchecked</span>(<span class="ident">size</span>, <span class="ident">align</span>); <span class="ident">System</span>.<span class="ident">alloc_zeroed</span>(<span class="ident">layout</span>) } } </pre> </section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "std";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>