Change panic::update_hook to simplify usage

And to remove possibility of panics while changing the panic handler,
because that resulted in a double panic.
This commit is contained in:
Badel2 2022-01-07 17:04:33 +01:00
parent 8bdf5c3de6
commit 8ef3ce866e
5 changed files with 71 additions and 54 deletions

View file

@ -1783,12 +1783,10 @@ thread_local!(static SILENCE_PANIC: Cell<bool> = Cell::new(false));
#[test]
#[cfg_attr(target_os = "emscripten", ignore)] // no threads
fn panic_safe() {
panic::update_hook(|prev| {
Box::new(move |info| {
if !SILENCE_PANIC.with(|s| s.get()) {
prev(info);
}
})
panic::update_hook(move |prev, info| {
if !SILENCE_PANIC.with(|s| s.get()) {
prev(info);
}
});
let mut rng = thread_rng();

View file

@ -310,16 +310,14 @@ impl Bridge<'_> {
// NB. the server can't do this because it may use a different libstd.
static HIDE_PANICS_DURING_EXPANSION: Once = Once::new();
HIDE_PANICS_DURING_EXPANSION.call_once(|| {
panic::update_hook(|prev| {
Box::new(move |info| {
let show = BridgeState::with(|state| match state {
BridgeState::NotConnected => true,
BridgeState::Connected(_) | BridgeState::InUse => force_show_panics,
});
if show {
prev(info)
}
})
panic::update_hook(move |prev, info| {
let show = BridgeState::with(|state| match state {
BridgeState::NotConnected => true,
BridgeState::Connected(_) | BridgeState::InUse => force_show_panics,
});
if show {
prev(info)
}
});
});

View file

@ -76,6 +76,12 @@ enum Hook {
Custom(*mut (dyn Fn(&PanicInfo<'_>) + 'static + Sync + Send)),
}
impl Hook {
fn custom(f: impl Fn(&PanicInfo<'_>) + 'static + Sync + Send) -> Self {
Self::Custom(Box::into_raw(Box::new(f)))
}
}
static HOOK_LOCK: StaticRWLock = StaticRWLock::new();
static mut HOOK: Hook = Hook::Default;
@ -180,7 +186,8 @@ pub fn take_hook() -> Box<dyn Fn(&PanicInfo<'_>) + 'static + Sync + Send> {
}
}
/// Atomic combination of [`take_hook`] + [`set_hook`].
/// Atomic combination of [`take_hook`] and [`set_hook`]. Use this to replace the panic handler with
/// a new panic handler that does something and then executes the old handler.
///
/// [`take_hook`]: ./fn.take_hook.html
/// [`set_hook`]: ./fn.set_hook.html
@ -189,16 +196,6 @@ pub fn take_hook() -> Box<dyn Fn(&PanicInfo<'_>) + 'static + Sync + Send> {
///
/// Panics if called from a panicking thread.
///
/// Panics if the provided closure calls any of the functions [`panic::take_hook`],
/// [`panic::set_hook`], or [`panic::update_hook`].
///
/// Note: if the provided closure panics, the panic will not be able to be handled, resulting in a
/// double panic that aborts the process with a generic error message.
///
/// [`panic::take_hook`]: ./fn.take_hook.html
/// [`panic::set_hook`]: ./fn.set_hook.html
/// [`panic::update_hook`]: ./fn.update_hook.html
///
/// # Examples
///
/// The following will print the custom message, and then the normal output of panic.
@ -207,11 +204,15 @@ pub fn take_hook() -> Box<dyn Fn(&PanicInfo<'_>) + 'static + Sync + Send> {
/// #![feature(panic_update_hook)]
/// use std::panic;
///
/// panic::update_hook(|prev| {
/// Box::new(move |panic_info| {
/// println!("Print custom message and execute panic handler as usual");
/// prev(panic_info);
/// })
/// // Equivalent to
/// // let prev = panic::take_hook();
/// // panic::set_hook(move |info| {
/// // println!("...");
/// // prev(info);
/// // );
/// panic::update_hook(move |prev, info| {
/// println!("Print custom message and execute panic handler as usual");
/// prev(info);
/// });
///
/// panic!("Custom and then normal");
@ -219,9 +220,10 @@ pub fn take_hook() -> Box<dyn Fn(&PanicInfo<'_>) + 'static + Sync + Send> {
#[unstable(feature = "panic_update_hook", issue = "92649")]
pub fn update_hook<F>(hook_fn: F)
where
F: FnOnce(
Box<dyn Fn(&PanicInfo<'_>) + 'static + Sync + Send>,
) -> Box<dyn Fn(&PanicInfo<'_>) + 'static + Sync + Send>,
F: Fn(&(dyn Fn(&PanicInfo<'_>) + Send + Sync + 'static), &PanicInfo<'_>)
+ Sync
+ Send
+ 'static,
{
if thread::panicking() {
panic!("cannot modify the panic hook from a panicking thread");
@ -232,13 +234,12 @@ where
let old_hook = HOOK;
HOOK = Hook::Default;
let hook_for_fn = match old_hook {
let prev = match old_hook {
Hook::Default => Box::new(default_hook),
Hook::Custom(ptr) => Box::from_raw(ptr),
};
let hook = hook_fn(hook_for_fn);
HOOK = Hook::Custom(Box::into_raw(hook));
HOOK = Hook::custom(move |info| hook_fn(&prev, info));
drop(guard);
}
}

View file

@ -0,0 +1,36 @@
// run-pass
// needs-unwind
#![allow(stable_features)]
// ignore-emscripten no threads support
#![feature(std_panic)]
#![feature(panic_update_hook)]
use std::sync::atomic::{AtomicUsize, Ordering};
use std::panic;
use std::thread;
static A: AtomicUsize = AtomicUsize::new(0);
static B: AtomicUsize = AtomicUsize::new(0);
static C: AtomicUsize = AtomicUsize::new(0);
fn main() {
panic::set_hook(Box::new(|_| { A.fetch_add(1, Ordering::SeqCst); }));
panic::update_hook(|prev, info| {
B.fetch_add(1, Ordering::SeqCst);
prev(info);
});
panic::update_hook(|prev, info| {
C.fetch_add(1, Ordering::SeqCst);
prev(info);
});
let _ = thread::spawn(|| {
panic!();
}).join();
assert_eq!(1, A.load(Ordering::SeqCst));
assert_eq!(1, B.load(Ordering::SeqCst));
assert_eq!(1, C.load(Ordering::SeqCst));
}

View file

@ -1,16 +0,0 @@
// run-fail
// error-pattern: panicked while processing panic
#![allow(stable_features)]
// ignore-emscripten no threads support
#![feature(std_panic)]
#![feature(panic_update_hook)]
use std::panic;
fn main() {
panic::update_hook(|_prev| {
panic!("inside update_hook");
})
}