heap.rs.html -- source
Description: Source to the Rust file `src/libstd/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

    // Copyright 2017 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.

    //! dox

    #![unstable(issue = "32838", feature = "allocator_api")]

    pub use alloc::heap::{Heap, Alloc, Layout, Excess, CannotReallocInPlace, AllocErr};
    pub use alloc_system::System;

    #[cfg(not(test))]
    #[doc(hidden)]
    pub mod __default_lib_allocator {
        use super::{System, Layout, Alloc, AllocErr};
        use ptr;

        // for symbol names src/librustc/middle/allocator.rs
        // for signatures src/librustc_allocator/lib.rs

        // linkage directives are provided as part of the current compiler allocator
        // ABI

        #[no_mangle]
        pub unsafe extern fn __rdl_alloc(size: usize,
                                         align: usize,
                                         err: *mut u8) -> *mut u8 {
            let layout = Layout::from_size_align_unchecked(size, align);
            match System.alloc(layout) {
                Ok(p) => p,
                Err(e) => {
                    ptr::write(err as *mut AllocErr, e);
                    0 as *mut u8
                }
            }
        }

        #[no_mangle]
        pub unsafe extern fn __rdl_oom(err: *const u8) -> ! {
            System.oom((*(err as *const AllocErr)).clone())
        }

        #[no_mangle]
        pub unsafe extern fn __rdl_dealloc(ptr: *mut u8,
                                           size: usize,
                                           align: usize) {
            System.dealloc(ptr, Layout::from_size_align_unchecked(size, align))
        }

        #[no_mangle]
        pub unsafe extern fn __rdl_usable_size(layout: *const u8,
                                               min: *mut usize,
                                               max: *mut usize) {
            let pair = System.usable_size(&*(layout as *const Layout));
            *min = pair.0;
            *max = pair.1;
        }

        #[no_mangle]
        pub unsafe extern fn __rdl_realloc(ptr: *mut u8,
                                           old_size: usize,
                                           old_align: usize,
                                           new_size: usize,
                                           new_align: usize,
                                           err: *mut u8) -> *mut u8 {
            let old_layout = Layout::from_size_align_unchecked(old_size, old_align);
            let new_layout = Layout::from_size_align_unchecked(new_size, new_align);
            match System.realloc(ptr, old_layout, new_layout) {
                Ok(p) => p,
                Err(e) => {
                    ptr::write(err as *mut AllocErr, e);
                    0 as *mut u8
                }
            }
        }

        #[no_mangle]
        pub unsafe extern fn __rdl_alloc_zeroed(size: usize,
                                                align: usize,
                                                err: *mut u8) -> *mut u8 {
            let layout = Layout::from_size_align_unchecked(size, align);
            match System.alloc_zeroed(layout) {
                Ok(p) => p,
                Err(e) => {
                    ptr::write(err as *mut AllocErr, e);
                    0 as *mut u8
                }
            }
        }

        #[no_mangle]
        pub unsafe extern fn __rdl_alloc_excess(size: usize,
                                                align: usize,
                                                excess: *mut usize,
                                                err: *mut u8) -> *mut u8 {
            let layout = Layout::from_size_align_unchecked(size, align);
            match System.alloc_excess(layout) {
                Ok(p) => {
                    *excess = p.1;
                    p.0
                }
                Err(e) => {
                    ptr::write(err as *mut AllocErr, e);
                    0 as *mut u8
                }
            }
        }

        #[no_mangle]
        pub unsafe extern fn __rdl_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 {
            let old_layout = Layout::from_size_align_unchecked(old_size, old_align);
            let new_layout = Layout::from_size_align_unchecked(new_size, new_align);
            match System.realloc_excess(ptr, old_layout, new_layout) {
                Ok(p) => {
                    *excess = p.1;
                    p.0
                }
                Err(e) => {
                    ptr::write(err as *mut AllocErr, e);
                    0 as *mut u8
                }
            }
        }

        #[no_mangle]
        pub unsafe extern fn __rdl_grow_in_place(ptr: *mut u8,
                                                 old_size: usize,
                                                 old_align: usize,
                                                 new_size: usize,
                                                 new_align: usize) -> u8 {
            let old_layout = Layout::from_size_align_unchecked(old_size, old_align);
            let new_layout = Layout::from_size_align_unchecked(new_size, new_align);
            match System.grow_in_place(ptr, old_layout, new_layout) {
                Ok(()) => 1,
                Err(_) => 0,
            }
        }

        #[no_mangle]
        pub unsafe extern fn __rdl_shrink_in_place(ptr: *mut u8,
                                                   old_size: usize,
                                                   old_align: usize,
                                                   new_size: usize,
                                                   new_align: usize) -> u8 {
            let old_layout = Layout::from_size_align_unchecked(old_size, old_align);
            let new_layout = Layout::from_size_align_unchecked(new_size, new_align);
            match System.shrink_in_place(ptr, old_layout, new_layout) {
                Ok(()) => 1,
                Err(_) => 0,
            }
        }
    }

# 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`)