rust-lang/rust
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Make the OOM hook return () rather than !

Browse Source 
Per discussion in https://github.com/rust-lang/rust/issues/51245#issuecomment-393651083

This allows more flexibility in what can be done with the API. This also
splits `rtabort!` into `dumb_print` happening in the default hook and
`abort_internal`, happening in the actual oom handler after calling the
hook. Registering an empty function thus makes the oom handler not print
anything but still abort.

Cc: @alexcrichton
This commit is contained in:
Mike Hommey
2018-06-01 08:50:07 +09:00
parent e38554cd80
commit b945be71e8
1 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/libstd/alloc.rs
View File

@@ -19,21 +19,22 @@
use core::sync::atomic::{AtomicPtr, Ordering}; use core::sync::atomic::{AtomicPtr, Ordering};
use core::{mem, ptr}; use core::{mem, ptr};
use sys_common::util::dumb_print;
static HOOK: AtomicPtr<()> = AtomicPtr::new(ptr::null_mut()); static HOOK: AtomicPtr<()> = AtomicPtr::new(ptr::null_mut());
/// Registers a custom OOM hook, replacing any that was previously registered. /// Registers a custom OOM hook, replacing any that was previously registered.
/// ///
/// The OOM hook is invoked when an infallible memory allocation fails. /// The OOM hook is invoked when an infallible memory allocation fails, before
/// The default hook prints a message to standard error and aborts the /// the runtime aborts. The default hook prints a message to standard error,
/// execution, but this behavior can be customized with the [`set_oom_hook`] /// but this behavior can be customized with the [`set_oom_hook`] and
/// and [`take_oom_hook`] functions. /// [`take_oom_hook`] functions.
/// ///
/// The hook is provided with a `Layout` struct which contains information /// The hook is provided with a `Layout` struct which contains information
/// about the allocation that failed. /// about the allocation that failed.
/// ///
/// The OOM hook is a global resource. /// The OOM hook is a global resource.
pub fn set_oom_hook(hook: fn(Layout) -> !) { pub fn set_oom_hook(hook: fn(Layout)) {
HOOK.store(hook as *mut (), Ordering::SeqCst); HOOK.store(hook as *mut (), Ordering::SeqCst);
} }
@@ -42,7 +43,7 @@ pub fn set_oom_hook(hook: fn(Layout) -> !) {
/// *See also the function [`set_oom_hook`].* /// *See also the function [`set_oom_hook`].*
/// ///
/// If no custom hook is registered, the default hook will be returned. /// If no custom hook is registered, the default hook will be returned.
pub fn take_oom_hook() -> fn(Layout) -> ! { pub fn take_oom_hook() -> fn(Layout) {
let hook = HOOK.swap(ptr::null_mut(), Ordering::SeqCst); let hook = HOOK.swap(ptr::null_mut(), Ordering::SeqCst);
if hook.is_null() { if hook.is_null() {
default_oom_hook default_oom_hook
@@ -51,8 +52,8 @@ pub fn take_oom_hook() -> fn(Layout) -> ! {
} }
} }
fn default_oom_hook(layout: Layout) -> ! { fn default_oom_hook(layout: Layout) {
rtabort!("memory allocation of {} bytes failed", layout.size()) dumb_print(format_args!("memory allocation of {} bytes failed", layout.size()));
} }
#[cfg(not(test))] #[cfg(not(test))]
@@ -60,12 +61,13 @@ fn default_oom_hook(layout: Layout) -> ! {
#[lang = "oom"] #[lang = "oom"]
pub extern fn rust_oom(layout: Layout) -> ! { pub extern fn rust_oom(layout: Layout) -> ! {
let hook = HOOK.load(Ordering::SeqCst); let hook = HOOK.load(Ordering::SeqCst);
let hook: fn(Layout) -> ! = if hook.is_null() { let hook: fn(Layout) = if hook.is_null() {
default_oom_hook default_oom_hook
} else { } else {
unsafe { mem::transmute(hook) } unsafe { mem::transmute(hook) }
}; };
hook(layout) hook(layout);
unsafe { ::sys::abort_internal(); }
} }
#[cfg(not(test))] #[cfg(not(test))]