src/libstd/panicking.rs

   1 // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Implementation of various bits and pieces of the `panic!` macro and
  12 //! associated runtime pieces.
  13 //!
  14 //! Specifically, this module contains the implementation of:
  15 //!
  16 //! * Panic hooks
  17 //! * Executing a panic up to doing the actual implementation
  18 //! * Shims around "try"
  19
  20 use core::panic::BoxMeUp;
  21
  22 use io::prelude::*;
  23
  24 use any::Any;
  25 use cell::RefCell;
  26 use core::panic::{PanicInfo, Location};
  27 use fmt;
  28 use intrinsics;
  29 use mem;
  30 use ptr;
  31 use raw;
  32 use sys::stdio::{Stderr, stderr_prints_nothing};
  33 use sys_common::rwlock::RWLock;
  34 use sys_common::thread_info;
  35 use sys_common::util;
  36 use thread;
  37
  38 thread_local! {
  39     pub static LOCAL_STDERR: RefCell<Option<Box<dyn Write + Send>>> = {
  40         RefCell::new(None)
  41     }
  42 }
  43
  44 // Binary interface to the panic runtime that the standard library depends on.
  45 //
  46 // The standard library is tagged with `#![needs_panic_runtime]` (introduced in
  47 // RFC 1513) to indicate that it requires some other crate tagged with
  48 // `#![panic_runtime]` to exist somewhere. Each panic runtime is intended to
  49 // implement these symbols (with the same signatures) so we can get matched up
  50 // to them.
  51 //
  52 // One day this may look a little less ad-hoc with the compiler helping out to
  53 // hook up these functions, but it is not this day!
  54 #[allow(improper_ctypes)]
  55 extern {
  56     fn __rust_maybe_catch_panic(f: fn(*mut u8),
  57                                 data: *mut u8,
  58                                 data_ptr: *mut usize,
  59                                 vtable_ptr: *mut usize) -> u32;
  60     #[unwind(allowed)]
  61     fn __rust_start_panic(payload: usize) -> u32;
  62 }
  63
  64 #[derive(Copy, Clone)]
  65 enum Hook {
  66     Default,
  67     Custom(*mut (dyn Fn(&PanicInfo) + 'static + Sync + Send)),
  68 }
  69
  70 static HOOK_LOCK: RWLock = RWLock::new();
  71 static mut HOOK: Hook = Hook::Default;
  72
  73 /// Registers a custom panic hook, replacing any that was previously registered.
  74 ///
  75 /// The panic hook is invoked when a thread panics, but before the panic runtime
  76 /// is invoked. As such, the hook will run with both the aborting and unwinding
  77 /// runtimes. The default hook prints a message to standard error and generates
  78 /// a backtrace if requested, but this behavior can be customized with the
  79 /// `set_hook` and [`take_hook`] functions.
  80 ///
  81 /// [`take_hook`]: ./fn.take_hook.html
  82 ///
  83 /// The hook is provided with a `PanicInfo` struct which contains information
  84 /// about the origin of the panic, including the payload passed to `panic!` and
  85 /// the source code location from which the panic originated.
  86 ///
  87 /// The panic hook is a global resource.
  88 ///
  89 /// # Panics
  90 ///
  91 /// Panics if called from a panicking thread.
  92 ///
  93 /// # Examples
  94 ///
  95 /// The following will print "Custom panic hook":
  96 ///
  97 /// ```should_panic
  98 /// use std::panic;
  99 ///
 100 /// panic::set_hook(Box::new(|_| {
 101 ///     println!("Custom panic hook");
 102 /// }));
 103 ///
 104 /// panic!("Normal panic");
 105 /// ```
 106 #[stable(feature = "panic_hooks", since = "1.10.0")]
 107 pub fn set_hook(hook: Box<dyn Fn(&PanicInfo) + 'static + Sync + Send>) {
 108     if thread::panicking() {
 109         panic!("cannot modify the panic hook from a panicking thread");
 110     }
 111
 112     unsafe {
 113         HOOK_LOCK.write();
 114         let old_hook = HOOK;
 115         HOOK = Hook::Custom(Box::into_raw(hook));
 116         HOOK_LOCK.write_unlock();
 117
 118         if let Hook::Custom(ptr) = old_hook {
 119             Box::from_raw(ptr);
 120         }
 121     }
 122 }
 123
 124 /// Unregisters the current panic hook, returning it.
 125 ///
 126 /// *See also the function [`set_hook`].*
 127 ///
 128 /// [`set_hook`]: ./fn.set_hook.html
 129 ///
 130 /// If no custom hook is registered, the default hook will be returned.
 131 ///
 132 /// # Panics
 133 ///
 134 /// Panics if called from a panicking thread.
 135 ///
 136 /// # Examples
 137 ///
 138 /// The following will print "Normal panic":
 139 ///
 140 /// ```should_panic
 141 /// use std::panic;
 142 ///
 143 /// panic::set_hook(Box::new(|_| {
 144 ///     println!("Custom panic hook");
 145 /// }));
 146 ///
 147 /// let _ = panic::take_hook();
 148 ///
 149 /// panic!("Normal panic");
 150 /// ```
 151 #[stable(feature = "panic_hooks", since = "1.10.0")]
 152 pub fn take_hook() -> Box<dyn Fn(&PanicInfo) + 'static + Sync + Send> {
 153     if thread::panicking() {
 154         panic!("cannot modify the panic hook from a panicking thread");
 155     }
 156
 157     unsafe {
 158         HOOK_LOCK.write();
 159         let hook = HOOK;
 160         HOOK = Hook::Default;
 161         HOOK_LOCK.write_unlock();
 162
 163         match hook {
 164             Hook::Default => Box::new(default_hook),
 165             Hook::Custom(ptr) => Box::from_raw(ptr),
 166         }
 167     }
 168 }
 169
 170 fn default_hook(info: &PanicInfo) {
 171     #[cfg(feature = "backtrace")]
 172     use sys_common::backtrace;
 173
 174     // If this is a double panic, make sure that we print a backtrace
 175     // for this panic. Otherwise only print it if logging is enabled.
 176     #[cfg(feature = "backtrace")]
 177     let log_backtrace = {
 178         let panics = update_panic_count(0);
 179
 180         if panics >= 2 {
 181             Some(backtrace::PrintFormat::Full)
 182         } else {
 183             backtrace::log_enabled()
 184         }
 185     };
 186
 187     let location = info.location().unwrap();  // The current implementation always returns Some
 188
 189     let msg = match info.payload().downcast_ref::<&'static str>() {
 190         Some(s) => *s,
 191         None => match info.payload().downcast_ref::<String>() {
 192             Some(s) => &s[..],
 193             None => "Box<Any>",
 194         }
 195     };
 196     let mut err = Stderr::new().ok();
 197     let thread = thread_info::current_thread();
 198     let name = thread.as_ref().and_then(|t| t.name()).unwrap_or("<unnamed>");
 199
 200     let write = |err: &mut dyn (::io::Write)| {
 201         let _ = writeln!(err, "thread '{}' panicked at '{}', {}",
 202                          name, msg, location);
 203
 204         #[cfg(feature = "backtrace")]
 205         {
 206             use sync::atomic::{AtomicBool, Ordering};
 207
 208             static FIRST_PANIC: AtomicBool = AtomicBool::new(true);
 209
 210             if let Some(format) = log_backtrace {
 211                 let _ = backtrace::print(err, format);
 212             } else if FIRST_PANIC.compare_and_swap(true, false, Ordering::SeqCst) {
 213                 let _ = writeln!(err, "note: Run with `RUST_BACKTRACE=1` for a backtrace.");
 214             }
 215         }
 216     };
 217
 218     let prev = LOCAL_STDERR.with(|s| s.borrow_mut().take());
 219     match (prev, err.as_mut()) {
 220        (Some(mut stderr), _) => {
 221            write(&mut *stderr);
 222            let mut s = Some(stderr);
 223            LOCAL_STDERR.with(|slot| {
 224                *slot.borrow_mut() = s.take();
 225            });
 226        }
 227        (None, Some(ref mut err)) => { write(err) }
 228        _ => {}
 229     }
 230 }
 231
 232
 233 #[cfg(not(test))]
 234 #[doc(hidden)]
 235 #[unstable(feature = "update_panic_count", issue = "0")]
 236 pub fn update_panic_count(amt: isize) -> usize {
 237     use cell::Cell;
 238     thread_local! { static PANIC_COUNT: Cell<usize> = Cell::new(0) }
 239
 240     PANIC_COUNT.with(|c| {
 241         let next = (c.get() as isize + amt) as usize;
 242         c.set(next);
 243         return next
 244     })
 245 }
 246
 247 #[cfg(test)]
 248 pub use realstd::rt::update_panic_count;
 249
 250 /// Invoke a closure, capturing the cause of an unwinding panic if one occurs.
 251 pub unsafe fn try<R, F: FnOnce() -> R>(f: F) -> Result<R, Box<dyn Any + Send>> {
 252     #[allow(unions_with_drop_fields)]
 253     union Data<F, R> {
 254         f: F,
 255         r: R,
 256     }
 257
 258     // We do some sketchy operations with ownership here for the sake of
 259     // performance. We can only  pass pointers down to
 260     // `__rust_maybe_catch_panic` (can't pass objects by value), so we do all
 261     // the ownership tracking here manually using a union.
 262     //
 263     // We go through a transition where:
 264     //
 265     // * First, we set the data to be the closure that we're going to call.
 266     // * When we make the function call, the `do_call` function below, we take
 267     //   ownership of the function pointer. At this point the `Data` union is
 268     //   entirely uninitialized.
 269     // * If the closure successfully returns, we write the return value into the
 270     //   data's return slot. Note that `ptr::write` is used as it's overwriting
 271     //   uninitialized data.
 272     // * Finally, when we come back out of the `__rust_maybe_catch_panic` we're
 273     //   in one of two states:
 274     //
 275     //      1. The closure didn't panic, in which case the return value was
 276     //         filled in. We move it out of `data` and return it.
 277     //      2. The closure panicked, in which case the return value wasn't
 278     //         filled in. In this case the entire `data` union is invalid, so
 279     //         there is no need to drop anything.
 280     //
 281     // Once we stack all that together we should have the "most efficient'
 282     // method of calling a catch panic whilst juggling ownership.
 283     let mut any_data = 0;
 284     let mut any_vtable = 0;
 285     let mut data = Data {
 286         f,
 287     };
 288
 289     let r = __rust_maybe_catch_panic(do_call::<F, R>,
 290                                      &mut data as *mut _ as *mut u8,
 291                                      &mut any_data,
 292                                      &mut any_vtable);
 293
 294     return if r == 0 {
 295         debug_assert!(update_panic_count(0) == 0);
 296         Ok(data.r)
 297     } else {
 298         update_panic_count(-1);
 299         debug_assert!(update_panic_count(0) == 0);
 300         Err(mem::transmute(raw::TraitObject {
 301             data: any_data as *mut _,
 302             vtable: any_vtable as *mut _,
 303         }))
 304     };
 305
 306     fn do_call<F: FnOnce() -> R, R>(data: *mut u8) {
 307         unsafe {
 308             let data = data as *mut Data<F, R>;
 309             let f = ptr::read(&mut (*data).f);
 310             ptr::write(&mut (*data).r, f());
 311         }
 312     }
 313 }
 314
 315 /// Determines whether the current thread is unwinding because of panic.
 316 pub fn panicking() -> bool {
 317     update_panic_count(0) != 0
 318 }
 319
 320 /// Entry point of panic from the libcore crate.
 321 #[cfg(not(test))]
 322 #[panic_handler]
 323 #[unwind(allowed)]
 324 pub fn rust_begin_panic(info: &PanicInfo) -> ! {
 325     continue_panic_fmt(&info)
 326 }
 327
 328 /// The entry point for panicking with a formatted message.
 329 ///
 330 /// This is designed to reduce the amount of code required at the call
 331 /// site as much as possible (so that `panic!()` has as low an impact
 332 /// on (e.g.) the inlining of other functions as possible), by moving
 333 /// the actual formatting into this shared place.
 334 #[unstable(feature = "libstd_sys_internals",
 335            reason = "used by the panic! macro",
 336            issue = "0")]
 337 #[cold]
 338 // If panic_immediate_abort, inline the abort call,
 339 // otherwise avoid inlining because of it is cold path.
 340 #[cfg_attr(not(feature="panic_immediate_abort"),inline(never))]
 341 #[cfg_attr(    feature="panic_immediate_abort" ,inline)]
 342 pub fn begin_panic_fmt(msg: &fmt::Arguments,
 343                        file_line_col: &(&'static str, u32, u32)) -> ! {
 344     if cfg!(feature = "panic_immediate_abort") {
 345         unsafe { intrinsics::abort() }
 346     }
 347
 348     let (file, line, col) = *file_line_col;
 349     let info = PanicInfo::internal_constructor(
 350         Some(msg),
 351         Location::internal_constructor(file, line, col),
 352     );
 353     continue_panic_fmt(&info)
 354 }
 355
 356 fn continue_panic_fmt(info: &PanicInfo) -> ! {
 357     struct PanicPayload<'a> {
 358         inner: &'a fmt::Arguments<'a>,
 359         string: Option<String>,
 360     }
 361
 362     impl<'a> PanicPayload<'a> {
 363         fn new(inner: &'a fmt::Arguments<'a>) -> PanicPayload<'a> {
 364             PanicPayload { inner, string: None }
 365         }
 366
 367         fn fill(&mut self) -> &mut String {
 368             use fmt::Write;
 369
 370             let inner = self.inner;
 371             self.string.get_or_insert_with(|| {
 372                 let mut s = String::new();
 373                 drop(s.write_fmt(*inner));
 374                 s
 375             })
 376         }
 377     }
 378
 379     unsafe impl<'a> BoxMeUp for PanicPayload<'a> {
 380         fn box_me_up(&mut self) -> *mut (dyn Any + Send) {
 381             let contents = mem::replace(self.fill(), String::new());
 382             Box::into_raw(Box::new(contents))
 383         }
 384
 385         fn get(&mut self) -> &(dyn Any + Send) {
 386             self.fill()
 387         }
 388     }
 389
 390     // We do two allocations here, unfortunately. But (a) they're
 391     // required with the current scheme, and (b) we don't handle
 392     // panic + OOM properly anyway (see comment in begin_panic
 393     // below).
 394
 395     let loc = info.location().unwrap(); // The current implementation always returns Some
 396     let msg = info.message().unwrap(); // The current implementation always returns Some
 397     let file_line_col = (loc.file(), loc.line(), loc.column());
 398     rust_panic_with_hook(
 399         &mut PanicPayload::new(msg),
 400         info.message(),
 401         &file_line_col);
 402 }
 403
 404 /// This is the entry point of panicking for panic!() and assert!().
 405 #[unstable(feature = "libstd_sys_internals",
 406            reason = "used by the panic! macro",
 407            issue = "0")]
 408 #[cfg_attr(not(test), lang = "begin_panic")]
 409 // never inline unless panic_immediate_abort to avoid code
 410 // bloat at the call sites as much as possible
 411 #[cfg_attr(not(feature="panic_immediate_abort"),inline(never))]
 412 #[cold]
 413 pub fn begin_panic<M: Any + Send>(msg: M, file_line_col: &(&'static str, u32, u32)) -> ! {
 414     if cfg!(feature = "panic_immediate_abort") {
 415         unsafe { intrinsics::abort() }
 416     }
 417
 418     // Note that this should be the only allocation performed in this code path.
 419     // Currently this means that panic!() on OOM will invoke this code path,
 420     // but then again we're not really ready for panic on OOM anyway. If
 421     // we do start doing this, then we should propagate this allocation to
 422     // be performed in the parent of this thread instead of the thread that's
 423     // panicking.
 424
 425     rust_panic_with_hook(&mut PanicPayload::new(msg), None, file_line_col);
 426
 427     struct PanicPayload<A> {
 428         inner: Option<A>,
 429     }
 430
 431     impl<A: Send + 'static> PanicPayload<A> {
 432         fn new(inner: A) -> PanicPayload<A> {
 433             PanicPayload { inner: Some(inner) }
 434         }
 435     }
 436
 437     unsafe impl<A: Send + 'static> BoxMeUp for PanicPayload<A> {
 438         fn box_me_up(&mut self) -> *mut (dyn Any + Send) {
 439             let data = match self.inner.take() {
 440                 Some(a) => Box::new(a) as Box<dyn Any + Send>,
 441                 None => Box::new(()),
 442             };
 443             Box::into_raw(data)
 444         }
 445
 446         fn get(&mut self) -> &(dyn Any + Send) {
 447             match self.inner {
 448                 Some(ref a) => a,
 449                 None => &(),
 450             }
 451         }
 452     }
 453 }
 454
 455 /// Central point for dispatching panics.
 456 ///
 457 /// Executes the primary logic for a panic, including checking for recursive
 458 /// panics, panic hooks, and finally dispatching to the panic runtime to either
 459 /// abort or unwind.
 460 fn rust_panic_with_hook(payload: &mut dyn BoxMeUp,
 461                         message: Option<&fmt::Arguments>,
 462                         file_line_col: &(&str, u32, u32)) -> ! {
 463     let (file, line, col) = *file_line_col;
 464
 465     let panics = update_panic_count(1);
 466
 467     // If this is the third nested call (e.g. panics == 2, this is 0-indexed),
 468     // the panic hook probably triggered the last panic, otherwise the
 469     // double-panic check would have aborted the process. In this case abort the
 470     // process real quickly as we don't want to try calling it again as it'll
 471     // probably just panic again.
 472     if panics > 2 {
 473         util::dumb_print(format_args!("thread panicked while processing \
 474                                        panic. aborting.\n"));
 475         unsafe { intrinsics::abort() }
 476     }
 477
 478     unsafe {
 479         let mut info = PanicInfo::internal_constructor(
 480             message,
 481             Location::internal_constructor(file, line, col),
 482         );
 483         HOOK_LOCK.read();
 484         match HOOK {
 485             // Some platforms know that printing to stderr won't ever actually
 486             // print anything, and if that's the case we can skip the default
 487             // hook.
 488             Hook::Default if stderr_prints_nothing() => {}
 489             Hook::Default => {
 490                 info.set_payload(payload.get());
 491                 default_hook(&info);
 492             }
 493             Hook::Custom(ptr) => {
 494                 info.set_payload(payload.get());
 495                 (*ptr)(&info);
 496             }
 497         }
 498         HOOK_LOCK.read_unlock();
 499     }
 500
 501     if panics > 1 {
 502         // If a thread panics while it's already unwinding then we
 503         // have limited options. Currently our preference is to
 504         // just abort. In the future we may consider resuming
 505         // unwinding or otherwise exiting the thread cleanly.
 506         util::dumb_print(format_args!("thread panicked while panicking. \
 507                                        aborting.\n"));
 508         unsafe { intrinsics::abort() }
 509     }
 510
 511     rust_panic(payload)
 512 }
 513
 514 /// Shim around rust_panic. Called by resume_unwind.
 515 pub fn update_count_then_panic(msg: Box<dyn Any + Send>) -> ! {
 516     update_panic_count(1);
 517
 518     struct RewrapBox(Box<dyn Any + Send>);
 519
 520     unsafe impl BoxMeUp for RewrapBox {
 521         fn box_me_up(&mut self) -> *mut (dyn Any + Send) {
 522             Box::into_raw(mem::replace(&mut self.0, Box::new(())))
 523         }
 524
 525         fn get(&mut self) -> &(dyn Any + Send) {
 526             &*self.0
 527         }
 528     }
 529
 530     rust_panic(&mut RewrapBox(msg))
 531 }
 532
 533 /// An unmangled function (through `rustc_std_internal_symbol`) on which to slap
 534 /// yer breakpoints.
 535 #[inline(never)]
 536 #[cfg_attr(not(test), rustc_std_internal_symbol)]
 537 fn rust_panic(mut msg: &mut dyn BoxMeUp) -> ! {
 538     let code = unsafe {
 539         let obj = &mut msg as *mut &mut dyn BoxMeUp;
 540         __rust_start_panic(obj as usize)
 541     };
 542     rtabort!("failed to initiate panic, error {}", code)
 543 }