]> git.lizzy.rs Git - rust.git/blob - src/libpanic_unwind/lib.rs
Rollup merge of #60131 - agnxy:doc-link, r=ehuss
[rust.git] / src / libpanic_unwind / 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. The 64-bit MinGW target half-uses SEH and half-use gcc-like information
9 //!    in the `seh64_gnu.rs` module.
10 //! 3. All other targets use libunwind/libgcc in the `gcc/mod.rs` module.
11 //!
12 //! More documentation about each implementation can be found in the respective
13 //! module.
14
15 #![no_std]
16 #![unstable(feature = "panic_unwind", issue = "32837")]
17 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/",
18        issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")]
19
20 #![deny(rust_2018_idioms)]
21
22 #![feature(core_intrinsics)]
23 #![feature(lang_items)]
24 #![feature(libc)]
25 #![feature(nll)]
26 #![feature(panic_unwind)]
27 #![feature(raw)]
28 #![feature(staged_api)]
29 #![feature(std_internals)]
30 #![feature(unwind_attributes)]
31
32 #![panic_runtime]
33 #![feature(panic_runtime)]
34
35 use alloc::boxed::Box;
36 use core::intrinsics;
37 use core::mem;
38 use core::raw;
39 use core::panic::BoxMeUp;
40
41 #[macro_use]
42 mod macros;
43
44 cfg_if! {
45     if #[cfg(target_os = "emscripten")] {
46         #[path = "emcc.rs"]
47         mod imp;
48     } else if #[cfg(target_arch = "wasm32")] {
49         #[path = "dummy.rs"]
50         mod imp;
51     } else if #[cfg(all(target_env = "msvc", target_arch = "aarch64"))] {
52         #[path = "dummy.rs"]
53         mod imp;
54     } else if #[cfg(target_env = "msvc")] {
55         #[path = "seh.rs"]
56         mod imp;
57     } else if #[cfg(all(windows, target_arch = "x86_64", target_env = "gnu"))] {
58         #[path = "seh64_gnu.rs"]
59         mod imp;
60     } else {
61         // Rust runtime's startup objects depend on these symbols, so make them public.
62         #[cfg(all(target_os="windows", target_arch = "x86", target_env="gnu"))]
63         pub use imp::eh_frame_registry::*;
64         #[path = "gcc.rs"]
65         mod imp;
66     }
67 }
68
69 mod dwarf;
70 mod windows;
71
72 // Entry point for catching an exception, implemented using the `try` intrinsic
73 // in the compiler.
74 //
75 // The interaction between the `payload` function and the compiler is pretty
76 // hairy and tightly coupled, for more information see the compiler's
77 // implementation of this.
78 #[no_mangle]
79 pub unsafe extern "C" fn __rust_maybe_catch_panic(f: fn(*mut u8),
80                                                   data: *mut u8,
81                                                   data_ptr: *mut usize,
82                                                   vtable_ptr: *mut usize)
83                                                   -> u32 {
84     let mut payload = imp::payload();
85     if intrinsics::r#try(f, data, &mut payload as *mut _ as *mut _) == 0 {
86         0
87     } else {
88         let obj = mem::transmute::<_, raw::TraitObject>(imp::cleanup(payload));
89         *data_ptr = obj.data as usize;
90         *vtable_ptr = obj.vtable as usize;
91         1
92     }
93 }
94
95 // Entry point for raising an exception, just delegates to the platform-specific
96 // implementation.
97 #[no_mangle]
98 #[unwind(allowed)]
99 pub unsafe extern "C" fn __rust_start_panic(payload: usize) -> u32 {
100     let payload = payload as *mut &mut dyn BoxMeUp;
101     imp::panic(Box::from_raw((*payload).box_me_up()))
102 }