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

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

    use core::sync::atomic::{AtomicPtr, Ordering};
    use core::mem;
    use core::intrinsics;

    static OOM_HANDLER: AtomicPtr<()> = AtomicPtr::new(default_oom_handler as *mut ());

    fn default_oom_handler() -> ! {
        // The default handler can't do much more since we can't assume the presence
        // of libc or any way of printing an error message.
        unsafe { intrinsics::abort() }
    }

    /// Common out-of-memory routine
    #[cold]
    #[inline(never)]
    #[unstable(feature = "oom", reason = "not a scrutinized interface",
               issue = "27700")]
    pub fn oom() -> ! {
        let value = OOM_HANDLER.load(Ordering::SeqCst);
        let handler: fn() -> ! = unsafe { mem::transmute(value) };
        handler();
    }

    /// Set a custom handler for out-of-memory conditions
    ///
    /// To avoid recursive OOM failures, it is critical that the OOM handler does
    /// not allocate any memory itself.
    #[unstable(feature = "oom", reason = "not a scrutinized interface",
               issue = "27700")]
    pub fn set_oom_handler(handler: fn() -> !) {
        OOM_HANDLER.store(handler as *mut (), Ordering::SeqCst);
    }

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