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