library/core/src/panicking.rs

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