src/libcore/panicking.rs

   1 //! Panic support for libcore
   2 //!
   3 //! The core library cannot define panicking, but it does *declare* panicking. This
   4 //! means that the functions inside of libcore are allowed to panic, but to be
   5 //! useful an upstream crate must define panicking for libcore to use. The current
   6 //! interface for panicking is:
   7 //!
   8 //! ```
   9 //! fn panic_impl(pi: &core::panic::PanicInfo<'_>) -> !
  10 //! # { loop {} }
  11 //! ```
  12 //!
  13 //! This definition allows for panicking with any general message, but it does not
  14 //! allow for failing with a `Box<Any>` value. (`PanicInfo` just contains a `&(dyn Any + Send)`,
  15 //! for which we fill in a dummy value in `PanicInfo::internal_constructor`.)
  16 //! The reason for this is that libcore is not allowed to allocate.
  17 //!
  18 //! This module contains a few other panicking functions, but these are just the
  19 //! necessary lang items for the compiler. All panics are funneled through this
  20 //! one function. The actual symbol is declared through the `#[panic_handler]` attribute.
  21
  22 // ignore-tidy-undocumented-unsafe
  23
  24 #![allow(dead_code, missing_docs)]
  25 #![unstable(
  26     feature = "core_panic",
  27     reason = "internal details of the implementation of the `panic!` \
  28               and related macros",
  29     issue = "none"
  30 )]
  31
  32 use crate::fmt;
  33 use crate::panic::{Location, PanicInfo};
  34
  35 #[cold]
  36 // never inline unless panic_immediate_abort to avoid code
  37 // bloat at the call sites as much as possible
  38 #[cfg_attr(not(feature = "panic_immediate_abort"), inline(never))]
  39 #[track_caller]
  40 #[lang = "panic"] // needed by codegen for panic on overflow and other `Assert` MIR terminators
  41 pub fn panic(expr: &str) -> ! {
  42     if cfg!(feature = "panic_immediate_abort") {
  43         unsafe { super::intrinsics::abort() }
  44     }
  45
  46     // Use Arguments::new_v1 instead of format_args!("{}", expr) to potentially
  47     // reduce size overhead. The format_args! macro uses str's Display trait to
  48     // write expr, which calls Formatter::pad, which must accommodate string
  49     // truncation and padding (even though none is used here). Using
  50     // Arguments::new_v1 may allow the compiler to omit Formatter::pad from the
  51     // output binary, saving up to a few kilobytes.
  52     panic_fmt(fmt::Arguments::new_v1(&[expr], &[]), Location::caller())
  53 }
  54
  55 #[cold]
  56 #[cfg_attr(not(feature = "panic_immediate_abort"), inline(never))]
  57 #[lang = "panic_bounds_check"] // needed by codegen for panic on OOB array/slice access
  58 fn panic_bounds_check(location: &Location<'_>, index: usize, len: usize) -> ! {
  59     if cfg!(feature = "panic_immediate_abort") {
  60         unsafe { super::intrinsics::abort() }
  61     }
  62
  63     panic_fmt(
  64         format_args!("index out of bounds: the len is {} but the index is {}", len, index),
  65         location,
  66     )
  67 }
  68
  69 #[cold]
  70 #[cfg_attr(not(feature = "panic_immediate_abort"), inline(never))]
  71 #[cfg_attr(feature = "panic_immediate_abort", inline)]
  72 pub fn panic_fmt(fmt: fmt::Arguments<'_>, location: &Location<'_>) -> ! {
  73     if cfg!(feature = "panic_immediate_abort") {
  74         unsafe { super::intrinsics::abort() }
  75     }
  76
  77     // NOTE This function never crosses the FFI boundary; it's a Rust-to-Rust call
  78     // that gets resolved to the `#[panic_handler]` function.
  79     extern "Rust" {
  80         #[lang = "panic_impl"]
  81         fn panic_impl(pi: &PanicInfo<'_>) -> !;
  82     }
  83
  84     let pi = PanicInfo::internal_constructor(Some(&fmt), location);
  85     unsafe { panic_impl(&pi) }
  86 }