heap.rs.html -- source
Description: Source to the Rust file `src/liballoc/heap.rs`.
Keywords: rust, rustlang, rust-lang

      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

    // Copyright 2014-2015 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    #![unstable(feature = "allocator_api",
                reason = "the precise API and guarantees it provides may be tweaked \
                          slightly, especially to possibly take into account the \
                          types being stored to make room for a future \
                          tracing garbage collector",
                issue = "32838")]

    use core::intrinsics::{min_align_of_val, size_of_val};
    use core::mem::{self, ManuallyDrop};
    use core::usize;

    pub use allocator::*;
    #[doc(hidden)]
    pub mod __core {
        pub use core::*;
    }

    extern "Rust" {
        #[allocator]
        #[rustc_allocator_nounwind]
        fn __rust_alloc(size: usize, align: usize, err: *mut u8) -> *mut u8;
        #[cold]
        #[rustc_allocator_nounwind]
        fn __rust_oom(err: *const u8) -> !;
        #[rustc_allocator_nounwind]
        fn __rust_dealloc(ptr: *mut u8, size: usize, align: usize);
        #[rustc_allocator_nounwind]
        fn __rust_usable_size(layout: *const u8,
                              min: *mut usize,
                              max: *mut usize);
        #[rustc_allocator_nounwind]
        fn __rust_realloc(ptr: *mut u8,
                          old_size: usize,
                          old_align: usize,
                          new_size: usize,
                          new_align: usize,
                          err: *mut u8) -> *mut u8;
        #[rustc_allocator_nounwind]
        fn __rust_alloc_zeroed(size: usize, align: usize, err: *mut u8) -> *mut u8;
        #[rustc_allocator_nounwind]
        fn __rust_alloc_excess(size: usize,
                               align: usize,
                               excess: *mut usize,
                               err: *mut u8) -> *mut u8;
        #[rustc_allocator_nounwind]
        fn __rust_realloc_excess(ptr: *mut u8,
                                 old_size: usize,
                                 old_align: usize,
                                 new_size: usize,
                                 new_align: usize,
                                 excess: *mut usize,
                                 err: *mut u8) -> *mut u8;
        #[rustc_allocator_nounwind]
        fn __rust_grow_in_place(ptr: *mut u8,
                                old_size: usize,
                                old_align: usize,
                                new_size: usize,
                                new_align: usize) -> u8;
        #[rustc_allocator_nounwind]
        fn __rust_shrink_in_place(ptr: *mut u8,
                                  old_size: usize,
                                  old_align: usize,
                                  new_size: usize,
                                  new_align: usize) -> u8;
    }

    #[derive(Copy, Clone, Default, Debug)]
    pub struct Heap;

    unsafe impl Alloc for Heap {
        #[inline]
        unsafe fn alloc(&mut self, layout: Layout) -> Result<*mut u8, AllocErr> {
            let mut err = ManuallyDrop::new(mem::uninitialized::<AllocErr>());
            let ptr = __rust_alloc(layout.size(),
                                   layout.align(),
                                   &mut *err as *mut AllocErr as *mut u8);
            if ptr.is_null() {
                Err(ManuallyDrop::into_inner(err))
            } else {
                Ok(ptr)
            }
        }

        #[inline]
        #[cold]
        fn oom(&mut self, err: AllocErr) -> ! {
            unsafe {
                __rust_oom(&err as *const AllocErr as *const u8)
            }
        }

        #[inline]
        unsafe fn dealloc(&mut self, ptr: *mut u8, layout: Layout) {
            __rust_dealloc(ptr, layout.size(), layout.align())
        }

        #[inline]
        fn usable_size(&self, layout: &Layout) -> (usize, usize) {
            let mut min = 0;
            let mut max = 0;
            unsafe {
                __rust_usable_size(layout as *const Layout as *const u8,
                                   &mut min,
                                   &mut max);
            }
            (min, max)
        }

        #[inline]
        unsafe fn realloc(&mut self,
                          ptr: *mut u8,
                          layout: Layout,
                          new_layout: Layout)
                          -> Result<*mut u8, AllocErr>
        {
            let mut err = ManuallyDrop::new(mem::uninitialized::<AllocErr>());
            let ptr = __rust_realloc(ptr,
                                     layout.size(),
                                     layout.align(),
                                     new_layout.size(),
                                     new_layout.align(),
                                     &mut *err as *mut AllocErr as *mut u8);
            if ptr.is_null() {
                Err(ManuallyDrop::into_inner(err))
            } else {
                mem::forget(err);
                Ok(ptr)
            }
        }

        #[inline]
        unsafe fn alloc_zeroed(&mut self, layout: Layout) -> Result<*mut u8, AllocErr> {
            let mut err = ManuallyDrop::new(mem::uninitialized::<AllocErr>());
            let ptr = __rust_alloc_zeroed(layout.size(),
                                          layout.align(),
                                          &mut *err as *mut AllocErr as *mut u8);
            if ptr.is_null() {
                Err(ManuallyDrop::into_inner(err))
            } else {
                Ok(ptr)
            }
        }

        #[inline]
        unsafe fn alloc_excess(&mut self, layout: Layout) -> Result<Excess, AllocErr> {
            let mut err = ManuallyDrop::new(mem::uninitialized::<AllocErr>());
            let mut size = 0;
            let ptr = __rust_alloc_excess(layout.size(),
                                          layout.align(),
                                          &mut size,
                                          &mut *err as *mut AllocErr as *mut u8);
            if ptr.is_null() {
                Err(ManuallyDrop::into_inner(err))
            } else {
                Ok(Excess(ptr, size))
            }
        }

        #[inline]
        unsafe fn realloc_excess(&mut self,
                                 ptr: *mut u8,
                                 layout: Layout,
                                 new_layout: Layout) -> Result<Excess, AllocErr> {
            let mut err = ManuallyDrop::new(mem::uninitialized::<AllocErr>());
            let mut size = 0;
            let ptr = __rust_realloc_excess(ptr,
                                            layout.size(),
                                            layout.align(),
                                            new_layout.size(),
                                            new_layout.align(),
                                            &mut size,
                                            &mut *err as *mut AllocErr as *mut u8);
            if ptr.is_null() {
                Err(ManuallyDrop::into_inner(err))
            } else {
                Ok(Excess(ptr, size))
            }
        }

        #[inline]
        unsafe fn grow_in_place(&mut self,
                                ptr: *mut u8,
                                layout: Layout,
                                new_layout: Layout)
                                -> Result<(), CannotReallocInPlace>
        {
            debug_assert!(new_layout.size() >= layout.size());
            debug_assert!(new_layout.align() == layout.align());
            let ret = __rust_grow_in_place(ptr,
                                           layout.size(),
                                           layout.align(),
                                           new_layout.size(),
                                           new_layout.align());
            if ret != 0 {
                Ok(())
            } else {
                Err(CannotReallocInPlace)
            }
        }

        #[inline]
        unsafe fn shrink_in_place(&mut self,
                                  ptr: *mut u8,
                                  layout: Layout,
                                  new_layout: Layout) -> Result<(), CannotReallocInPlace> {
            debug_assert!(new_layout.size() <= layout.size());
            debug_assert!(new_layout.align() == layout.align());
            let ret = __rust_shrink_in_place(ptr,
                                             layout.size(),
                                             layout.align(),
                                             new_layout.size(),
                                             new_layout.align());
            if ret != 0 {
                Ok(())
            } else {
                Err(CannotReallocInPlace)
            }
        }
    }

    /// An arbitrary non-null address to represent zero-size allocations.
    ///
    /// This preserves the non-null invariant for types like `Box<T>`. The address
    /// may overlap with non-zero-size memory allocations.
    #[rustc_deprecated(since = "1.19", reason = "Use Unique/Shared::empty() instead")]
    #[unstable(feature = "heap_api", issue = "27700")]
    pub const EMPTY: *mut () = 1 as *mut ();

    /// The allocator for unique pointers.
    // This function must not unwind. If it does, MIR trans will fail.
    #[cfg(not(test))]
    #[lang = "exchange_malloc"]
    #[inline]
    unsafe fn exchange_malloc(size: usize, align: usize) -> *mut u8 {
        if size == 0 {
            align as *mut u8
        } else {
            let layout = Layout::from_size_align_unchecked(size, align);
            Heap.alloc(layout).unwrap_or_else(|err| {
                Heap.oom(err)
            })
        }
    }

    #[cfg_attr(not(test), lang = "box_free")]
    #[inline]
    pub(crate) unsafe fn box_free<T: ?Sized>(ptr: *mut T) {
        let size = size_of_val(&*ptr);
        let align = min_align_of_val(&*ptr);
        // We do not allocate for Box<T> when T is ZST, so deallocation is also not necessary.
        if size != 0 {
            let layout = Layout::from_size_align_unchecked(size, align);
            Heap.dealloc(ptr as *mut u8, layout);
        }
    }

    #[cfg(test)]
    mod tests {
        extern crate test;
        use self::test::Bencher;
        use boxed::Box;
        use heap::{Heap, Alloc, Layout};

        #[test]
        fn allocate_zeroed() {
            unsafe {
                let layout = Layout::from_size_align(1024, 1).unwrap();
                let ptr = Heap.alloc_zeroed(layout.clone())
                    .unwrap_or_else(|e| Heap.oom(e));

                let end = ptr.offset(layout.size() as isize);
                let mut i = ptr;
                while i < end {
                    assert_eq!(*i, 0);
                    i = i.offset(1);
                }
                Heap.dealloc(ptr, layout);
            }
        }

        #[bench]
        fn alloc_owned_small(b: &mut Bencher) {
            b.iter(|| {
                let _: Box<_> = box 10;
            })
        }
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)