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 //! https://itanium-cxx-abi.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)]
49 use alloc::boxed::Box;
52 use crate::dwarf::eh::{self, EHAction, EHContext};
53 use libc::{c_int, uintptr_t};
58 _uwe: uw::_Unwind_Exception,
59 cause: Box<dyn Any + Send>,
62 pub unsafe fn panic(data: Box<dyn Any + Send>) -> u32 {
63 let exception = Box::new(Exception {
64 _uwe: uw::_Unwind_Exception {
65 exception_class: rust_exception_class(),
67 private: [0; uw::unwinder_private_data_size],
71 let exception_param = Box::into_raw(exception) as *mut uw::_Unwind_Exception;
72 return uw::_Unwind_RaiseException(exception_param) as u32;
74 extern "C" fn exception_cleanup(
75 _unwind_code: uw::_Unwind_Reason_Code,
76 exception: *mut uw::_Unwind_Exception,
79 let _: Box<Exception> = Box::from_raw(exception as *mut Exception);
80 super::__rust_drop_panic();
85 pub type Payload = *mut u8;
87 pub unsafe fn cleanup(ptr: *mut u8) -> Box<dyn Any + Send> {
88 let exception = Box::from_raw(ptr as *mut Exception);
92 // Rust's exception class identifier. This is used by personality routines to
93 // determine whether the exception was thrown by their own runtime.
94 fn rust_exception_class() -> uw::_Unwind_Exception_Class {
95 // M O Z \0 R U S T -- vendor, language
99 // Register ids were lifted from LLVM's TargetLowering::getExceptionPointerRegister()
100 // and TargetLowering::getExceptionSelectorRegister() for each architecture,
101 // then mapped to DWARF register numbers via register definition tables
102 // (typically <arch>RegisterInfo.td, search for "DwarfRegNum").
103 // See also http://llvm.org/docs/WritingAnLLVMBackend.html#defining-a-register.
105 #[cfg(target_arch = "x86")]
106 const UNWIND_DATA_REG: (i32, i32) = (0, 2); // EAX, EDX
108 #[cfg(target_arch = "x86_64")]
109 const UNWIND_DATA_REG: (i32, i32) = (0, 1); // RAX, RDX
111 #[cfg(any(target_arch = "arm", target_arch = "aarch64"))]
112 const UNWIND_DATA_REG: (i32, i32) = (0, 1); // R0, R1 / X0, X1
114 #[cfg(any(target_arch = "mips", target_arch = "mips64"))]
115 const UNWIND_DATA_REG: (i32, i32) = (4, 5); // A0, A1
117 #[cfg(any(target_arch = "powerpc", target_arch = "powerpc64"))]
118 const UNWIND_DATA_REG: (i32, i32) = (3, 4); // R3, R4 / X3, X4
120 #[cfg(target_arch = "s390x")]
121 const UNWIND_DATA_REG: (i32, i32) = (6, 7); // R6, R7
123 #[cfg(target_arch = "sparc64")]
124 const UNWIND_DATA_REG: (i32, i32) = (24, 25); // I0, I1
126 #[cfg(target_arch = "hexagon")]
127 const UNWIND_DATA_REG: (i32, i32) = (0, 1); // R0, R1
129 #[cfg(target_arch = "riscv64")]
130 const UNWIND_DATA_REG: (i32, i32) = (10, 11); // x10, x11
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
137 if #[cfg(all(target_arch = "arm", not(target_os = "ios"), not(target_os = "netbsd")))] {
138 // ARM EHABI personality routine.
139 // http://infocenter.arm.com/help/topic/com.arm.doc.ihi0038b/IHI0038B_ehabi.pdf
141 // iOS uses the default routine instead since it uses SjLj unwinding.
142 #[lang = "eh_personality"]
144 unsafe extern "C" fn rust_eh_personality(state: uw::_Unwind_State,
145 exception_object: *mut uw::_Unwind_Exception,
146 context: *mut uw::_Unwind_Context)
147 -> uw::_Unwind_Reason_Code {
148 let state = state as c_int;
149 let action = state & uw::_US_ACTION_MASK as c_int;
150 let search_phase = if action == uw::_US_VIRTUAL_UNWIND_FRAME as c_int {
151 // Backtraces on ARM will call the personality routine with
152 // state == _US_VIRTUAL_UNWIND_FRAME | _US_FORCE_UNWIND. In those cases
153 // we want to continue unwinding the stack, otherwise all our backtraces
154 // would end at __rust_try
155 if state & uw::_US_FORCE_UNWIND as c_int != 0 {
156 return continue_unwind(exception_object, context);
159 } else if action == uw::_US_UNWIND_FRAME_STARTING as c_int {
161 } else if action == uw::_US_UNWIND_FRAME_RESUME as c_int {
162 return continue_unwind(exception_object, context);
164 return uw::_URC_FAILURE;
167 // The DWARF unwinder assumes that _Unwind_Context holds things like the function
168 // and LSDA pointers, however ARM EHABI places them into the exception object.
169 // To preserve signatures of functions like _Unwind_GetLanguageSpecificData(), which
170 // take only the context pointer, GCC personality routines stash a pointer to
171 // exception_object in the context, using location reserved for ARM's
172 // "scratch register" (r12).
173 uw::_Unwind_SetGR(context,
174 uw::UNWIND_POINTER_REG,
175 exception_object as uw::_Unwind_Ptr);
176 // ...A more principled approach would be to provide the full definition of ARM's
177 // _Unwind_Context in our libunwind bindings and fetch the required data from there
178 // directly, bypassing DWARF compatibility functions.
180 let exception_class = (*exception_object).exception_class;
181 let foreign_exception = exception_class != rust_exception_class();
182 let eh_action = match find_eh_action(context, foreign_exception) {
183 Ok(action) => action,
184 Err(_) => return uw::_URC_FAILURE,
189 EHAction::Cleanup(_) => return continue_unwind(exception_object, context),
190 EHAction::Catch(_) => {
191 // EHABI requires the personality routine to update the
192 // SP value in the barrier cache of the exception object.
193 (*exception_object).private[5] =
194 uw::_Unwind_GetGR(context, uw::UNWIND_SP_REG);
195 return uw::_URC_HANDLER_FOUND;
197 EHAction::Terminate => return uw::_URC_FAILURE,
201 EHAction::None => return continue_unwind(exception_object, context),
202 EHAction::Cleanup(lpad) |
203 EHAction::Catch(lpad) => {
204 uw::_Unwind_SetGR(context, UNWIND_DATA_REG.0,
205 exception_object as uintptr_t);
206 uw::_Unwind_SetGR(context, UNWIND_DATA_REG.1, 0);
207 uw::_Unwind_SetIP(context, lpad);
208 return uw::_URC_INSTALL_CONTEXT;
210 EHAction::Terminate => return uw::_URC_FAILURE,
214 // On ARM EHABI the personality routine is responsible for actually
215 // unwinding a single stack frame before returning (ARM EHABI Sec. 6.1).
216 unsafe fn continue_unwind(exception_object: *mut uw::_Unwind_Exception,
217 context: *mut uw::_Unwind_Context)
218 -> uw::_Unwind_Reason_Code {
219 if __gnu_unwind_frame(exception_object, context) == uw::_URC_NO_REASON {
220 uw::_URC_CONTINUE_UNWIND
227 fn __gnu_unwind_frame(exception_object: *mut uw::_Unwind_Exception,
228 context: *mut uw::_Unwind_Context)
229 -> uw::_Unwind_Reason_Code;
233 // Default personality routine, which is used directly on most targets
234 // and indirectly on Windows x86_64 via SEH.
235 unsafe extern "C" fn rust_eh_personality_impl(version: c_int,
236 actions: uw::_Unwind_Action,
237 exception_class: uw::_Unwind_Exception_Class,
238 exception_object: *mut uw::_Unwind_Exception,
239 context: *mut uw::_Unwind_Context)
240 -> uw::_Unwind_Reason_Code {
242 return uw::_URC_FATAL_PHASE1_ERROR;
244 let foreign_exception = exception_class != rust_exception_class();
245 let eh_action = match find_eh_action(context, foreign_exception) {
246 Ok(action) => action,
247 Err(_) => return uw::_URC_FATAL_PHASE1_ERROR,
249 if actions as i32 & uw::_UA_SEARCH_PHASE as i32 != 0 {
252 EHAction::Cleanup(_) => uw::_URC_CONTINUE_UNWIND,
253 EHAction::Catch(_) => uw::_URC_HANDLER_FOUND,
254 EHAction::Terminate => uw::_URC_FATAL_PHASE1_ERROR,
258 EHAction::None => uw::_URC_CONTINUE_UNWIND,
259 EHAction::Cleanup(lpad) |
260 EHAction::Catch(lpad) => {
261 uw::_Unwind_SetGR(context, UNWIND_DATA_REG.0,
262 exception_object as uintptr_t);
263 uw::_Unwind_SetGR(context, UNWIND_DATA_REG.1, 0);
264 uw::_Unwind_SetIP(context, lpad);
265 uw::_URC_INSTALL_CONTEXT
267 EHAction::Terminate => uw::_URC_FATAL_PHASE2_ERROR,
273 if #[cfg(all(windows, target_arch = "x86_64", target_env = "gnu"))] {
274 // On x86_64 MinGW targets, the unwinding mechanism is SEH however the unwind
275 // handler data (aka LSDA) uses GCC-compatible encoding.
276 #[lang = "eh_personality"]
278 #[allow(nonstandard_style)]
279 unsafe extern "C" fn rust_eh_personality(exceptionRecord: *mut uw::EXCEPTION_RECORD,
280 establisherFrame: uw::LPVOID,
281 contextRecord: *mut uw::CONTEXT,
282 dispatcherContext: *mut uw::DISPATCHER_CONTEXT)
283 -> uw::EXCEPTION_DISPOSITION {
284 uw::_GCC_specific_handler(exceptionRecord,
288 rust_eh_personality_impl)
291 // The personality routine for most of our targets.
292 #[lang = "eh_personality"]
294 unsafe extern "C" fn rust_eh_personality(version: c_int,
295 actions: uw::_Unwind_Action,
296 exception_class: uw::_Unwind_Exception_Class,
297 exception_object: *mut uw::_Unwind_Exception,
298 context: *mut uw::_Unwind_Context)
299 -> uw::_Unwind_Reason_Code {
300 rust_eh_personality_impl(version,
311 unsafe fn find_eh_action(
312 context: *mut uw::_Unwind_Context,
313 foreign_exception: bool,
314 ) -> Result<EHAction, ()> {
315 let lsda = uw::_Unwind_GetLanguageSpecificData(context) as *const u8;
316 let mut ip_before_instr: c_int = 0;
317 let ip = uw::_Unwind_GetIPInfo(context, &mut ip_before_instr);
318 let eh_context = EHContext {
319 // The return address points 1 byte past the call instruction,
320 // which could be in the next IP range in LSDA range table.
321 ip: if ip_before_instr != 0 { ip } else { ip - 1 },
322 func_start: uw::_Unwind_GetRegionStart(context),
323 get_text_start: &|| uw::_Unwind_GetTextRelBase(context),
324 get_data_start: &|| uw::_Unwind_GetDataRelBase(context),
326 eh::find_eh_action(lsda, &eh_context, foreign_exception)
329 // See docs in the `unwind` module.
331 target_os = "windows",
332 any(target_arch = "x86", target_arch = "x86_64"),
335 #[lang = "eh_unwind_resume"]
337 unsafe extern "C" fn rust_eh_unwind_resume(panic_ctx: *mut u8) -> ! {
338 uw::_Unwind_Resume(panic_ctx as *mut uw::_Unwind_Exception);
341 // Frame unwind info registration
343 // Each module's image contains a frame unwind info section (usually
344 // ".eh_frame"). When a module is loaded/unloaded into the process, the
345 // unwinder must be informed about the location of this section in memory. The
346 // methods of achieving that vary by the platform. On some (e.g., Linux), the
347 // unwinder can discover unwind info sections on its own (by dynamically
348 // enumerating currently loaded modules via the dl_iterate_phdr() API and
349 // finding their ".eh_frame" sections); Others, like Windows, require modules
350 // to actively register their unwind info sections via unwinder API.
352 // This module defines two symbols which are referenced and called from
353 // rsbegin.rs to register our information with the GCC runtime. The
354 // implementation of stack unwinding is (for now) deferred to libgcc_eh, however
355 // Rust crates use these Rust-specific entry points to avoid potential clashes
356 // with any GCC runtime.
357 #[cfg(all(target_os = "windows", target_arch = "x86", target_env = "gnu"))]
358 pub mod eh_frame_registry {
360 fn __register_frame_info(eh_frame_begin: *const u8, object: *mut u8);
361 fn __deregister_frame_info(eh_frame_begin: *const u8, object: *mut u8);
365 pub unsafe extern "C" fn rust_eh_register_frames(eh_frame_begin: *const u8, object: *mut u8) {
366 __register_frame_info(eh_frame_begin, object);
370 pub unsafe extern "C" fn rust_eh_unregister_frames(eh_frame_begin: *const u8, object: *mut u8) {
371 __deregister_frame_info(eh_frame_begin, object);