library/panic_unwind/src/lib.rs

   1 //! Implementation of panics via stack unwinding
   2 //!
   3 //! This crate is an implementation of panics in Rust using "most native" stack
   4 //! unwinding mechanism of the platform this is being compiled for. This
   5 //! essentially gets categorized into three buckets currently:
   6 //!
   7 //! 1. MSVC targets use SEH in the `seh.rs` file.
   8 //! 2. Emscripten uses C++ exceptions in the `emcc.rs` file.
   9 //! 3. All other targets use libunwind/libgcc in the `gcc.rs` file.
  10 //!
  11 //! More documentation about each implementation can be found in the respective
  12 //! module.
  13
  14 #![no_std]
  15 #![unstable(feature = "panic_unwind", issue = "32837")]
  16 #![doc(issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")]
  17 #![feature(core_intrinsics)]
  18 #![feature(lang_items)]
  19 #![feature(nll)]
  20 #![feature(panic_unwind)]
  21 #![feature(staged_api)]
  22 #![feature(std_internals)]
  23 #![feature(abi_thiscall)]
  24 #![feature(rustc_attrs)]
  25 #![panic_runtime]
  26 #![feature(panic_runtime)]
  27 #![feature(c_unwind)]
  28 // `real_imp` is unused with Miri, so silence warnings.
  29 #![cfg_attr(miri, allow(dead_code))]
  30
  31 use alloc::boxed::Box;
  32 use core::any::Any;
  33 use core::panic::BoxMeUp;
  34
  35 cfg_if::cfg_if! {
  36     if #[cfg(target_os = "emscripten")] {
  37         #[path = "emcc.rs"]
  38         mod real_imp;
  39     } else if #[cfg(target_os = "hermit")] {
  40         #[path = "hermit.rs"]
  41         mod real_imp;
  42     } else if #[cfg(target_os = "l4re")] {
  43         // L4Re is unix family but does not yet support unwinding.
  44         #[path = "dummy.rs"]
  45         mod real_imp;
  46     } else if #[cfg(target_env = "msvc")] {
  47         #[path = "seh.rs"]
  48         mod real_imp;
  49     } else if #[cfg(any(
  50         all(target_family = "windows", target_env = "gnu"),
  51         target_os = "psp",
  52         target_os = "solid_asp3",
  53         all(target_family = "unix", not(target_os = "espidf")),
  54         all(target_vendor = "fortanix", target_env = "sgx"),
  55     ))] {
  56         // Rust runtime's startup objects depend on these symbols, so make them public.
  57         #[cfg(all(target_os="windows", target_arch = "x86", target_env="gnu"))]
  58         pub use real_imp::eh_frame_registry::*;
  59         #[path = "gcc.rs"]
  60         mod real_imp;
  61     } else {
  62         // Targets that don't support unwinding.
  63         // - family=wasm
  64         // - os=none ("bare metal" targets)
  65         // - os=uefi
  66         // - os=espidf
  67         // - nvptx64-nvidia-cuda
  68         // - arch=avr
  69         #[path = "dummy.rs"]
  70         mod real_imp;
  71     }
  72 }
  73
  74 cfg_if::cfg_if! {
  75     if #[cfg(miri)] {
  76         // Use the Miri runtime.
  77         // We still need to also load the normal runtime above, as rustc expects certain lang
  78         // items from there to be defined.
  79         #[path = "miri.rs"]
  80         mod imp;
  81     } else {
  82         // Use the real runtime.
  83         use real_imp as imp;
  84     }
  85 }
  86
  87 extern "C" {
  88     /// Handler in libstd called when a panic object is dropped outside of
  89     /// `catch_unwind`.
  90     fn __rust_drop_panic() -> !;
  91
  92     /// Handler in libstd called when a foreign exception is caught.
  93     fn __rust_foreign_exception() -> !;
  94 }
  95
  96 mod dwarf;
  97
  98 #[rustc_std_internal_symbol]
  99 #[allow(improper_ctypes_definitions)]
 100 pub unsafe extern "C" fn __rust_panic_cleanup(payload: *mut u8) -> *mut (dyn Any + Send + 'static) {
 101     Box::into_raw(imp::cleanup(payload))
 102 }
 103
 104 // Entry point for raising an exception, just delegates to the platform-specific
 105 // implementation.
 106 #[rustc_std_internal_symbol]
 107 pub unsafe extern "C-unwind" fn __rust_start_panic(payload: *mut &mut dyn BoxMeUp) -> u32 {
 108     let payload = Box::from_raw((*payload).take_box());
 109
 110     imp::panic(payload)
 111 }