library/core/src/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 #![allow(dead_code, missing_docs)]
  23 #![unstable(
  24     feature = "core_panic",
  25     reason = "internal details of the implementation of the `panic!` and related macros",
  26     issue = "none"
  27 )]
  28
  29 use crate::fmt;
  30 use crate::panic::{Location, PanicInfo};
  31
  32 /// The underlying implementation of libcore's `panic!` macro when no formatting is used.
  33 #[cold]
  34 // never inline unless panic_immediate_abort to avoid code
  35 // bloat at the call sites as much as possible
  36 #[cfg_attr(not(feature = "panic_immediate_abort"), inline(never))]
  37 #[cfg_attr(feature = "panic_immediate_abort", inline)]
  38 #[track_caller]
  39 #[rustc_const_unstable(feature = "core_panic", issue = "none")]
  40 #[lang = "panic"] // needed by codegen for panic on overflow and other `Assert` MIR terminators
  41 pub const fn panic(expr: &'static str) -> ! {
  42     // Use Arguments::new_v1 instead of format_args!("{}", expr) to potentially
  43     // reduce size overhead. The format_args! macro uses str's Display trait to
  44     // write expr, which calls Formatter::pad, which must accommodate string
  45     // truncation and padding (even though none is used here). Using
  46     // Arguments::new_v1 may allow the compiler to omit Formatter::pad from the
  47     // output binary, saving up to a few kilobytes.
  48     panic_fmt(fmt::Arguments::new_v1(&[expr], &[]));
  49 }
  50
  51 #[inline]
  52 #[track_caller]
  53 #[lang = "panic_str"] // needed for `non-fmt-panics` lint
  54 #[rustc_const_unstable(feature = "core_panic", issue = "none")]
  55 pub const fn panic_str(expr: &str) -> ! {
  56     panic_display(&expr);
  57 }
  58
  59 #[inline]
  60 #[track_caller]
  61 #[lang = "panic_display"] // needed for const-evaluated panics
  62 #[rustc_do_not_const_check] // hooked by const-eval
  63 #[rustc_const_unstable(feature = "core_panic", issue = "none")]
  64 pub const fn panic_display<T: fmt::Display>(x: &T) -> ! {
  65     panic_fmt(format_args!("{}", *x));
  66 }
  67
  68 #[cold]
  69 #[cfg_attr(not(feature = "panic_immediate_abort"), inline(never))]
  70 #[track_caller]
  71 #[lang = "panic_bounds_check"] // needed by codegen for panic on OOB array/slice access
  72 fn panic_bounds_check(index: usize, len: usize) -> ! {
  73     if cfg!(feature = "panic_immediate_abort") {
  74         super::intrinsics::abort()
  75     }
  76
  77     panic!("index out of bounds: the len is {} but the index is {}", len, index)
  78 }
  79
  80 #[cfg(not(bootstrap))]
  81 #[cold]
  82 #[cfg_attr(not(feature = "panic_immediate_abort"), inline(never))]
  83 #[track_caller]
  84 #[lang = "panic_no_unwind"] // needed by codegen for panic in nounwind function
  85 fn panic_no_unwind() -> ! {
  86     if cfg!(feature = "panic_immediate_abort") {
  87         super::intrinsics::abort()
  88     }
  89
  90     // NOTE This function never crosses the FFI boundary; it's a Rust-to-Rust call
  91     // that gets resolved to the `#[panic_handler]` function.
  92     extern "Rust" {
  93         #[lang = "panic_impl"]
  94         fn panic_impl(pi: &PanicInfo<'_>) -> !;
  95     }
  96
  97     // PanicInfo with the `can_unwind` flag set to false forces an abort.
  98     let fmt = format_args!("panic in a function that cannot unwind");
  99     let pi = PanicInfo::internal_constructor(Some(&fmt), Location::caller(), false);
 100
 101     // SAFETY: `panic_impl` is defined in safe Rust code and thus is safe to call.
 102     unsafe { panic_impl(&pi) }
 103 }
 104
 105 /// The entry point for panicking with a formatted message.
 106 ///
 107 /// This is designed to reduce the amount of code required at the call
 108 /// site as much as possible (so that `panic!()` has as low an impact
 109 /// on (e.g.) the inlining of other functions as possible), by moving
 110 /// the actual formatting into this shared place.
 111 #[cold]
 112 // If panic_immediate_abort, inline the abort call,
 113 // otherwise avoid inlining because of it is cold path.
 114 #[cfg_attr(not(feature = "panic_immediate_abort"), inline(never))]
 115 #[cfg_attr(feature = "panic_immediate_abort", inline)]
 116 #[track_caller]
 117 #[lang = "panic_fmt"] // needed for const-evaluated panics
 118 #[rustc_do_not_const_check] // hooked by const-eval
 119 #[rustc_const_unstable(feature = "core_panic", issue = "none")]
 120 pub const fn panic_fmt(fmt: fmt::Arguments<'_>) -> ! {
 121     if cfg!(feature = "panic_immediate_abort") {
 122         super::intrinsics::abort()
 123     }
 124
 125     // NOTE This function never crosses the FFI boundary; it's a Rust-to-Rust call
 126     // that gets resolved to the `#[panic_handler]` function.
 127     extern "Rust" {
 128         #[lang = "panic_impl"]
 129         fn panic_impl(pi: &PanicInfo<'_>) -> !;
 130     }
 131
 132     let pi = PanicInfo::internal_constructor(Some(&fmt), Location::caller(), true);
 133
 134     // SAFETY: `panic_impl` is defined in safe Rust code and thus is safe to call.
 135     unsafe { panic_impl(&pi) }
 136 }
 137
 138 /// This function is used instead of panic_fmt in const eval.
 139 #[lang = "const_panic_fmt"]
 140 #[rustc_const_unstable(feature = "core_panic", issue = "none")]
 141 pub const fn const_panic_fmt(fmt: fmt::Arguments<'_>) -> ! {
 142     if let Some(msg) = fmt.as_str() {
 143         panic_str(msg);
 144     } else {
 145         // SAFETY: This is only evaluated at compile time, which reliably
 146         // handles this UB (in case this branch turns out to be reachable
 147         // somehow).
 148         unsafe { crate::hint::unreachable_unchecked() };
 149     }
 150 }
 151
 152 #[derive(Debug)]
 153 #[doc(hidden)]
 154 pub enum AssertKind {
 155     Eq,
 156     Ne,
 157     Match,
 158 }
 159
 160 /// Internal function for `assert_eq!` and `assert_ne!` macros
 161 #[cold]
 162 #[track_caller]
 163 #[doc(hidden)]
 164 pub fn assert_failed<T, U>(
 165     kind: AssertKind,
 166     left: &T,
 167     right: &U,
 168     args: Option<fmt::Arguments<'_>>,
 169 ) -> !
 170 where
 171     T: fmt::Debug + ?Sized,
 172     U: fmt::Debug + ?Sized,
 173 {
 174     assert_failed_inner(kind, &left, &right, args)
 175 }
 176
 177 /// Internal function for `assert_match!`
 178 #[cold]
 179 #[track_caller]
 180 #[doc(hidden)]
 181 pub fn assert_matches_failed<T: fmt::Debug + ?Sized>(
 182     left: &T,
 183     right: &str,
 184     args: Option<fmt::Arguments<'_>>,
 185 ) -> ! {
 186     // Use the Display implementation to display the pattern.
 187     struct Pattern<'a>(&'a str);
 188     impl fmt::Debug for Pattern<'_> {
 189         fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 190             fmt::Display::fmt(self.0, f)
 191         }
 192     }
 193     assert_failed_inner(AssertKind::Match, &left, &Pattern(right), args);
 194 }
 195
 196 /// Non-generic version of the above functions, to avoid code bloat.
 197 #[track_caller]
 198 fn assert_failed_inner(
 199     kind: AssertKind,
 200     left: &dyn fmt::Debug,
 201     right: &dyn fmt::Debug,
 202     args: Option<fmt::Arguments<'_>>,
 203 ) -> ! {
 204     let op = match kind {
 205         AssertKind::Eq => "==",
 206         AssertKind::Ne => "!=",
 207         AssertKind::Match => "matches",
 208     };
 209
 210     match args {
 211         Some(args) => panic!(
 212             r#"assertion failed: `(left {} right)`
 213   left: `{:?}`,
 214  right: `{:?}`: {}"#,
 215             op, left, right, args
 216         ),
 217         None => panic!(
 218             r#"assertion failed: `(left {} right)`
 219   left: `{:?}`,
 220  right: `{:?}`"#,
 221             op, left, right,
 222         ),
 223     }
 224 }