1 //! Implementation of panics backed by libgcc/libunwind (in some form).
3 //! For background on exception handling and stack unwinding please see
4 //! "Exception Handling in LLVM" (llvm.org/docs/ExceptionHandling.html) and
5 //! documents linked from it.
6 //! These are also good reads:
7 //! http://mentorembedded.github.io/cxx-abi/abi-eh.html
8 //! http://monoinfinito.wordpress.com/series/exception-handling-in-c/
9 //! http://www.airs.com/blog/index.php?s=exception+frames
11 //! ## A brief summary
13 //! Exception handling happens in two phases: a search phase and a cleanup
16 //! In both phases the unwinder walks stack frames from top to bottom using
17 //! information from the stack frame unwind sections of the current process's
18 //! modules ("module" here refers to an OS module, i.e., an executable or a
21 //! For each stack frame, it invokes the associated "personality routine", whose
22 //! address is also stored in the unwind info section.
24 //! In the search phase, the job of a personality routine is to examine
25 //! exception object being thrown, and to decide whether it should be caught at
26 //! that stack frame. Once the handler frame has been identified, cleanup phase
29 //! In the cleanup phase, the unwinder invokes each personality routine again.
30 //! This time it decides which (if any) cleanup code needs to be run for
31 //! the current stack frame. If so, the control is transferred to a special
32 //! branch in the function body, the "landing pad", which invokes destructors,
33 //! frees memory, etc. At the end of the landing pad, control is transferred
34 //! back to the unwinder and unwinding resumes.
36 //! Once stack has been unwound down to the handler frame level, unwinding stops
37 //! and the last personality routine transfers control to the catch block.
39 //! ## `eh_personality` and `eh_unwind_resume`
41 //! These language items are used by the compiler when generating unwind info.
42 //! The first one is the personality routine described above. The second one
43 //! allows compilation target to customize the process of resuming unwind at the
44 //! end of the landing pads. `eh_unwind_resume` is used only if
45 //! `custom_unwind_resume` flag in the target options is set.
47 #![allow(private_no_mangle_fns)]
51 use alloc::boxed::Box;
54 use libc::{c_int, uintptr_t};
55 use crate::dwarf::eh::{self, EHContext, EHAction};
59 _uwe: uw::_Unwind_Exception,
60 cause: Option<Box<dyn Any + Send>>,
63 pub unsafe fn panic(data: Box<dyn Any + Send>) -> u32 {
64 let exception = Box::new(Exception {
65 _uwe: uw::_Unwind_Exception {
66 exception_class: rust_exception_class(),
68 private: [0; uw::unwinder_private_data_size],
72 let exception_param = Box::into_raw(exception) as *mut uw::_Unwind_Exception;
73 return uw::_Unwind_RaiseException(exception_param) as u32;
75 extern "C" fn exception_cleanup(_unwind_code: uw::_Unwind_Reason_Code,
76 exception: *mut uw::_Unwind_Exception) {
78 let _: Box<Exception> = Box::from_raw(exception as *mut Exception);
83 pub fn payload() -> *mut u8 {
87 pub unsafe fn cleanup(ptr: *mut u8) -> Box<dyn Any + Send> {
88 let my_ep = ptr as *mut Exception;
89 let cause = (*my_ep).cause.take();
90 uw::_Unwind_DeleteException(ptr as *mut _);
94 // Rust's exception class identifier. This is used by personality routines to
95 // determine whether the exception was thrown by their own runtime.
96 fn rust_exception_class() -> uw::_Unwind_Exception_Class {
97 // M O Z \0 R U S T -- vendor, language
102 // Register ids were lifted from LLVM's TargetLowering::getExceptionPointerRegister()
103 // and TargetLowering::getExceptionSelectorRegister() for each architecture,
104 // then mapped to DWARF register numbers via register definition tables
105 // (typically <arch>RegisterInfo.td, search for "DwarfRegNum").
106 // See also http://llvm.org/docs/WritingAnLLVMBackend.html#defining-a-register.
108 #[cfg(target_arch = "x86")]
109 const UNWIND_DATA_REG: (i32, i32) = (0, 2); // EAX, EDX
111 #[cfg(target_arch = "x86_64")]
112 const UNWIND_DATA_REG: (i32, i32) = (0, 1); // RAX, RDX
114 #[cfg(any(target_arch = "arm", target_arch = "aarch64"))]
115 const UNWIND_DATA_REG: (i32, i32) = (0, 1); // R0, R1 / X0, X1
117 #[cfg(any(target_arch = "mips", target_arch = "mips64"))]
118 const UNWIND_DATA_REG: (i32, i32) = (4, 5); // A0, A1
120 #[cfg(any(target_arch = "powerpc", target_arch = "powerpc64"))]
121 const UNWIND_DATA_REG: (i32, i32) = (3, 4); // R3, R4 / X3, X4
123 #[cfg(target_arch = "s390x")]
124 const UNWIND_DATA_REG: (i32, i32) = (6, 7); // R6, R7
126 #[cfg(target_arch = "sparc64")]
127 const UNWIND_DATA_REG: (i32, i32) = (24, 25); // I0, I1
129 #[cfg(target_arch = "hexagon")]
130 const UNWIND_DATA_REG: (i32, i32) = (0, 1); // R0, R1
132 // The following code is based on GCC's C and C++ personality routines. For reference, see:
133 // https://github.com/gcc-mirror/gcc/blob/master/libstdc++-v3/libsupc++/eh_personality.cc
134 // https://github.com/gcc-mirror/gcc/blob/trunk/libgcc/unwind-c.c
136 // The personality routine for most of our targets, except ARM, which has a slightly different ABI
137 // (however, iOS goes here as it uses SjLj unwinding). Also, the 64-bit Windows implementation
138 // lives in seh64_gnu.rs
139 #[cfg(all(any(target_os = "ios", target_os = "netbsd", not(target_arch = "arm"))))]
140 #[lang = "eh_personality"]
143 unsafe extern "C" fn rust_eh_personality(version: c_int,
144 actions: uw::_Unwind_Action,
145 exception_class: uw::_Unwind_Exception_Class,
146 exception_object: *mut uw::_Unwind_Exception,
147 context: *mut uw::_Unwind_Context)
148 -> uw::_Unwind_Reason_Code {
150 return uw::_URC_FATAL_PHASE1_ERROR;
152 let eh_action = match find_eh_action(context) {
153 Ok(action) => action,
154 Err(_) => return uw::_URC_FATAL_PHASE1_ERROR,
156 if actions as i32 & uw::_UA_SEARCH_PHASE as i32 != 0 {
159 EHAction::Cleanup(_) => uw::_URC_CONTINUE_UNWIND,
160 EHAction::Catch(_) => uw::_URC_HANDLER_FOUND,
161 EHAction::Terminate => uw::_URC_FATAL_PHASE1_ERROR,
165 EHAction::None => uw::_URC_CONTINUE_UNWIND,
166 EHAction::Cleanup(lpad) |
167 EHAction::Catch(lpad) => {
168 uw::_Unwind_SetGR(context, UNWIND_DATA_REG.0, exception_object as uintptr_t);
169 uw::_Unwind_SetGR(context, UNWIND_DATA_REG.1, 0);
170 uw::_Unwind_SetIP(context, lpad);
171 uw::_URC_INSTALL_CONTEXT
173 EHAction::Terminate => uw::_URC_FATAL_PHASE2_ERROR,
178 // ARM EHABI personality routine.
179 // http://infocenter.arm.com/help/topic/com.arm.doc.ihi0038b/IHI0038B_ehabi.pdf
180 #[cfg(all(target_arch = "arm", not(target_os = "ios"), not(target_os = "netbsd")))]
181 #[lang = "eh_personality"]
183 unsafe extern "C" fn rust_eh_personality(state: uw::_Unwind_State,
184 exception_object: *mut uw::_Unwind_Exception,
185 context: *mut uw::_Unwind_Context)
186 -> uw::_Unwind_Reason_Code {
187 let state = state as c_int;
188 let action = state & uw::_US_ACTION_MASK as c_int;
189 let search_phase = if action == uw::_US_VIRTUAL_UNWIND_FRAME as c_int {
190 // Backtraces on ARM will call the personality routine with
191 // state == _US_VIRTUAL_UNWIND_FRAME | _US_FORCE_UNWIND. In those cases
192 // we want to continue unwinding the stack, otherwise all our backtraces
193 // would end at __rust_try
194 if state & uw::_US_FORCE_UNWIND as c_int != 0 {
195 return continue_unwind(exception_object, context);
198 } else if action == uw::_US_UNWIND_FRAME_STARTING as c_int {
200 } else if action == uw::_US_UNWIND_FRAME_RESUME as c_int {
201 return continue_unwind(exception_object, context);
203 return uw::_URC_FAILURE;
206 // The DWARF unwinder assumes that _Unwind_Context holds things like the function
207 // and LSDA pointers, however ARM EHABI places them into the exception object.
208 // To preserve signatures of functions like _Unwind_GetLanguageSpecificData(), which
209 // take only the context pointer, GCC personality routines stash a pointer to exception_object
210 // in the context, using location reserved for ARM's "scratch register" (r12).
211 uw::_Unwind_SetGR(context,
212 uw::UNWIND_POINTER_REG,
213 exception_object as uw::_Unwind_Ptr);
214 // ...A more principled approach would be to provide the full definition of ARM's
215 // _Unwind_Context in our libunwind bindings and fetch the required data from there directly,
216 // bypassing DWARF compatibility functions.
218 let eh_action = match find_eh_action(context) {
219 Ok(action) => action,
220 Err(_) => return uw::_URC_FAILURE,
225 EHAction::Cleanup(_) => return continue_unwind(exception_object, context),
226 EHAction::Catch(_) => return uw::_URC_HANDLER_FOUND,
227 EHAction::Terminate => return uw::_URC_FAILURE,
231 EHAction::None => return continue_unwind(exception_object, context),
232 EHAction::Cleanup(lpad) |
233 EHAction::Catch(lpad) => {
234 uw::_Unwind_SetGR(context, UNWIND_DATA_REG.0, exception_object as uintptr_t);
235 uw::_Unwind_SetGR(context, UNWIND_DATA_REG.1, 0);
236 uw::_Unwind_SetIP(context, lpad);
237 return uw::_URC_INSTALL_CONTEXT;
239 EHAction::Terminate => return uw::_URC_FAILURE,
243 // On ARM EHABI the personality routine is responsible for actually
244 // unwinding a single stack frame before returning (ARM EHABI Sec. 6.1).
245 unsafe fn continue_unwind(exception_object: *mut uw::_Unwind_Exception,
246 context: *mut uw::_Unwind_Context)
247 -> uw::_Unwind_Reason_Code {
248 if __gnu_unwind_frame(exception_object, context) == uw::_URC_NO_REASON {
249 uw::_URC_CONTINUE_UNWIND
256 fn __gnu_unwind_frame(exception_object: *mut uw::_Unwind_Exception,
257 context: *mut uw::_Unwind_Context)
258 -> uw::_Unwind_Reason_Code;
262 unsafe fn find_eh_action(context: *mut uw::_Unwind_Context)
263 -> Result<EHAction, ()>
265 let lsda = uw::_Unwind_GetLanguageSpecificData(context) as *const u8;
266 let mut ip_before_instr: c_int = 0;
267 let ip = uw::_Unwind_GetIPInfo(context, &mut ip_before_instr);
268 let eh_context = EHContext {
269 // The return address points 1 byte past the call instruction,
270 // which could be in the next IP range in LSDA range table.
271 ip: if ip_before_instr != 0 { ip } else { ip - 1 },
272 func_start: uw::_Unwind_GetRegionStart(context),
273 get_text_start: &|| uw::_Unwind_GetTextRelBase(context),
274 get_data_start: &|| uw::_Unwind_GetDataRelBase(context),
276 eh::find_eh_action(lsda, &eh_context)
279 // See docs in the `unwind` module.
280 #[cfg(all(target_os="windows", target_arch = "x86", target_env="gnu"))]
281 #[lang = "eh_unwind_resume"]
283 unsafe extern "C" fn rust_eh_unwind_resume(panic_ctx: *mut u8) -> ! {
284 uw::_Unwind_Resume(panic_ctx as *mut uw::_Unwind_Exception);
287 // Frame unwind info registration
289 // Each module's image contains a frame unwind info section (usually
290 // ".eh_frame"). When a module is loaded/unloaded into the process, the
291 // unwinder must be informed about the location of this section in memory. The
292 // methods of achieving that vary by the platform. On some (e.g., Linux), the
293 // unwinder can discover unwind info sections on its own (by dynamically
294 // enumerating currently loaded modules via the dl_iterate_phdr() API and
295 // finding their ".eh_frame" sections); Others, like Windows, require modules
296 // to actively register their unwind info sections via unwinder API.
298 // This module defines two symbols which are referenced and called from
299 // rsbegin.rs to register our information with the GCC runtime. The
300 // implementation of stack unwinding is (for now) deferred to libgcc_eh, however
301 // Rust crates use these Rust-specific entry points to avoid potential clashes
302 // with any GCC runtime.
303 #[cfg(all(target_os="windows", target_arch = "x86", target_env="gnu"))]
304 pub mod eh_frame_registry {
306 fn __register_frame_info(eh_frame_begin: *const u8, object: *mut u8);
307 fn __deregister_frame_info(eh_frame_begin: *const u8, object: *mut u8);
311 pub unsafe extern "C" fn rust_eh_register_frames(eh_frame_begin: *const u8, object: *mut u8) {
312 __register_frame_info(eh_frame_begin, object);
316 pub unsafe extern "C" fn rust_eh_unregister_frames(eh_frame_begin: *const u8,
318 __deregister_frame_info(eh_frame_begin, object);