src/libpanic_unwind/gcc.rs

   1 //! Implementation of panics backed by libgcc/libunwind (in some form).
   2 //!
   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
  10 //!
  11 //! ## A brief summary
  12 //!
  13 //! Exception handling happens in two phases: a search phase and a cleanup
  14 //! phase.
  15 //!
  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
  19 //! dynamic library).
  20 //!
  21 //! For each stack frame, it invokes the associated "personality routine", whose
  22 //! address is also stored in the unwind info section.
  23 //!
  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
  27 //! begins.
  28 //!
  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.
  35 //!
  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.
  38
  39 #![allow(private_no_mangle_fns)]
  40
  41 use alloc::boxed::Box;
  42 use core::any::Any;
  43
  44 use crate::dwarf::eh::{self, EHAction, EHContext};
  45 use libc::{c_int, uintptr_t};
  46 use unwind as uw;
  47
  48 #[repr(C)]
  49 struct Exception {
  50     _uwe: uw::_Unwind_Exception,
  51     cause: Box<dyn Any + Send>,
  52 }
  53
  54 pub unsafe fn panic(data: Box<dyn Any + Send>) -> u32 {
  55     let exception = Box::new(Exception {
  56         _uwe: uw::_Unwind_Exception {
  57             exception_class: rust_exception_class(),
  58             exception_cleanup,
  59             private: [0; uw::unwinder_private_data_size],
  60         },
  61         cause: data,
  62     });
  63     let exception_param = Box::into_raw(exception) as *mut uw::_Unwind_Exception;
  64     return uw::_Unwind_RaiseException(exception_param) as u32;
  65
  66     extern "C" fn exception_cleanup(
  67         _unwind_code: uw::_Unwind_Reason_Code,
  68         exception: *mut uw::_Unwind_Exception,
  69     ) {
  70         unsafe {
  71             let _: Box<Exception> = Box::from_raw(exception as *mut Exception);
  72             super::__rust_drop_panic();
  73         }
  74     }
  75 }
  76
  77 pub unsafe fn cleanup(ptr: *mut u8) -> Box<dyn Any + Send> {
  78     let exception = Box::from_raw(ptr as *mut Exception);
  79     exception.cause
  80 }
  81
  82 // Rust's exception class identifier.  This is used by personality routines to
  83 // determine whether the exception was thrown by their own runtime.
  84 fn rust_exception_class() -> uw::_Unwind_Exception_Class {
  85     // M O Z \0  R U S T -- vendor, language
  86     0x4d4f5a_00_52555354
  87 }
  88
  89 // Register ids were lifted from LLVM's TargetLowering::getExceptionPointerRegister()
  90 // and TargetLowering::getExceptionSelectorRegister() for each architecture,
  91 // then mapped to DWARF register numbers via register definition tables
  92 // (typically <arch>RegisterInfo.td, search for "DwarfRegNum").
  93 // See also http://llvm.org/docs/WritingAnLLVMBackend.html#defining-a-register.
  94
  95 #[cfg(target_arch = "x86")]
  96 const UNWIND_DATA_REG: (i32, i32) = (0, 2); // EAX, EDX
  97
  98 #[cfg(target_arch = "x86_64")]
  99 const UNWIND_DATA_REG: (i32, i32) = (0, 1); // RAX, RDX
 100
 101 #[cfg(any(target_arch = "arm", target_arch = "aarch64"))]
 102 const UNWIND_DATA_REG: (i32, i32) = (0, 1); // R0, R1 / X0, X1
 103
 104 #[cfg(any(target_arch = "mips", target_arch = "mips64"))]
 105 const UNWIND_DATA_REG: (i32, i32) = (4, 5); // A0, A1
 106
 107 #[cfg(any(target_arch = "powerpc", target_arch = "powerpc64"))]
 108 const UNWIND_DATA_REG: (i32, i32) = (3, 4); // R3, R4 / X3, X4
 109
 110 #[cfg(target_arch = "s390x")]
 111 const UNWIND_DATA_REG: (i32, i32) = (6, 7); // R6, R7
 112
 113 #[cfg(target_arch = "sparc64")]
 114 const UNWIND_DATA_REG: (i32, i32) = (24, 25); // I0, I1
 115
 116 #[cfg(target_arch = "hexagon")]
 117 const UNWIND_DATA_REG: (i32, i32) = (0, 1); // R0, R1
 118
 119 #[cfg(target_arch = "riscv64")]
 120 const UNWIND_DATA_REG: (i32, i32) = (10, 11); // x10, x11
 121
 122 // The following code is based on GCC's C and C++ personality routines.  For reference, see:
 123 // https://github.com/gcc-mirror/gcc/blob/master/libstdc++-v3/libsupc++/eh_personality.cc
 124 // https://github.com/gcc-mirror/gcc/blob/trunk/libgcc/unwind-c.c
 125
 126 cfg_if::cfg_if! {
 127     if #[cfg(all(target_arch = "arm", not(target_os = "ios"), not(target_os = "netbsd")))] {
 128         // ARM EHABI personality routine.
 129         // http://infocenter.arm.com/help/topic/com.arm.doc.ihi0038b/IHI0038B_ehabi.pdf
 130         //
 131         // iOS uses the default routine instead since it uses SjLj unwinding.
 132         #[lang = "eh_personality"]
 133         unsafe extern "C" fn rust_eh_personality(state: uw::_Unwind_State,
 134                                                  exception_object: *mut uw::_Unwind_Exception,
 135                                                  context: *mut uw::_Unwind_Context)
 136                                                  -> uw::_Unwind_Reason_Code {
 137             let state = state as c_int;
 138             let action = state & uw::_US_ACTION_MASK as c_int;
 139             let search_phase = if action == uw::_US_VIRTUAL_UNWIND_FRAME as c_int {
 140                 // Backtraces on ARM will call the personality routine with
 141                 // state == _US_VIRTUAL_UNWIND_FRAME | _US_FORCE_UNWIND. In those cases
 142                 // we want to continue unwinding the stack, otherwise all our backtraces
 143                 // would end at __rust_try
 144                 if state & uw::_US_FORCE_UNWIND as c_int != 0 {
 145                     return continue_unwind(exception_object, context);
 146                 }
 147                 true
 148             } else if action == uw::_US_UNWIND_FRAME_STARTING as c_int {
 149                 false
 150             } else if action == uw::_US_UNWIND_FRAME_RESUME as c_int {
 151                 return continue_unwind(exception_object, context);
 152             } else {
 153                 return uw::_URC_FAILURE;
 154             };
 155
 156             // The DWARF unwinder assumes that _Unwind_Context holds things like the function
 157             // and LSDA pointers, however ARM EHABI places them into the exception object.
 158             // To preserve signatures of functions like _Unwind_GetLanguageSpecificData(), which
 159             // take only the context pointer, GCC personality routines stash a pointer to
 160             // exception_object in the context, using location reserved for ARM's
 161             // "scratch register" (r12).
 162             uw::_Unwind_SetGR(context,
 163                               uw::UNWIND_POINTER_REG,
 164                               exception_object as uw::_Unwind_Ptr);
 165             // ...A more principled approach would be to provide the full definition of ARM's
 166             // _Unwind_Context in our libunwind bindings and fetch the required data from there
 167             // directly, bypassing DWARF compatibility functions.
 168
 169             let exception_class = (*exception_object).exception_class;
 170             let foreign_exception = exception_class != rust_exception_class();
 171             let eh_action = match find_eh_action(context, foreign_exception) {
 172                 Ok(action) => action,
 173                 Err(_) => return uw::_URC_FAILURE,
 174             };
 175             if search_phase {
 176                 match eh_action {
 177                     EHAction::None |
 178                     EHAction::Cleanup(_) => return continue_unwind(exception_object, context),
 179                     EHAction::Catch(_) => {
 180                         // EHABI requires the personality routine to update the
 181                         // SP value in the barrier cache of the exception object.
 182                         (*exception_object).private[5] =
 183                             uw::_Unwind_GetGR(context, uw::UNWIND_SP_REG);
 184                         return uw::_URC_HANDLER_FOUND;
 185                     }
 186                     EHAction::Terminate => return uw::_URC_FAILURE,
 187                 }
 188             } else {
 189                 match eh_action {
 190                     EHAction::None => return continue_unwind(exception_object, context),
 191                     EHAction::Cleanup(lpad) |
 192                     EHAction::Catch(lpad) => {
 193                         uw::_Unwind_SetGR(context, UNWIND_DATA_REG.0,
 194                                           exception_object as uintptr_t);
 195                         uw::_Unwind_SetGR(context, UNWIND_DATA_REG.1, 0);
 196                         uw::_Unwind_SetIP(context, lpad);
 197                         return uw::_URC_INSTALL_CONTEXT;
 198                     }
 199                     EHAction::Terminate => return uw::_URC_FAILURE,
 200                 }
 201             }
 202
 203             // On ARM EHABI the personality routine is responsible for actually
 204             // unwinding a single stack frame before returning (ARM EHABI Sec. 6.1).
 205             unsafe fn continue_unwind(exception_object: *mut uw::_Unwind_Exception,
 206                                       context: *mut uw::_Unwind_Context)
 207                                       -> uw::_Unwind_Reason_Code {
 208                 if __gnu_unwind_frame(exception_object, context) == uw::_URC_NO_REASON {
 209                     uw::_URC_CONTINUE_UNWIND
 210                 } else {
 211                     uw::_URC_FAILURE
 212                 }
 213             }
 214             // defined in libgcc
 215             extern "C" {
 216                 fn __gnu_unwind_frame(exception_object: *mut uw::_Unwind_Exception,
 217                                       context: *mut uw::_Unwind_Context)
 218                                       -> uw::_Unwind_Reason_Code;
 219             }
 220         }
 221     } else {
 222         // Default personality routine, which is used directly on most targets
 223         // and indirectly on Windows x86_64 via SEH.
 224         unsafe extern "C" fn rust_eh_personality_impl(version: c_int,
 225                                                       actions: uw::_Unwind_Action,
 226                                                       exception_class: uw::_Unwind_Exception_Class,
 227                                                       exception_object: *mut uw::_Unwind_Exception,
 228                                                       context: *mut uw::_Unwind_Context)
 229                                                       -> uw::_Unwind_Reason_Code {
 230             if version != 1 {
 231                 return uw::_URC_FATAL_PHASE1_ERROR;
 232             }
 233             let foreign_exception = exception_class != rust_exception_class();
 234             let eh_action = match find_eh_action(context, foreign_exception) {
 235                 Ok(action) => action,
 236                 Err(_) => return uw::_URC_FATAL_PHASE1_ERROR,
 237             };
 238             if actions as i32 & uw::_UA_SEARCH_PHASE as i32 != 0 {
 239                 match eh_action {
 240                     EHAction::None |
 241                     EHAction::Cleanup(_) => uw::_URC_CONTINUE_UNWIND,
 242                     EHAction::Catch(_) => uw::_URC_HANDLER_FOUND,
 243                     EHAction::Terminate => uw::_URC_FATAL_PHASE1_ERROR,
 244                 }
 245             } else {
 246                 match eh_action {
 247                     EHAction::None => uw::_URC_CONTINUE_UNWIND,
 248                     EHAction::Cleanup(lpad) |
 249                     EHAction::Catch(lpad) => {
 250                         uw::_Unwind_SetGR(context, UNWIND_DATA_REG.0,
 251                             exception_object as uintptr_t);
 252                         uw::_Unwind_SetGR(context, UNWIND_DATA_REG.1, 0);
 253                         uw::_Unwind_SetIP(context, lpad);
 254                         uw::_URC_INSTALL_CONTEXT
 255                     }
 256                     EHAction::Terminate => uw::_URC_FATAL_PHASE2_ERROR,
 257                 }
 258             }
 259         }
 260
 261         cfg_if::cfg_if! {
 262             if #[cfg(all(windows, target_arch = "x86_64", target_env = "gnu"))] {
 263                 // On x86_64 MinGW targets, the unwinding mechanism is SEH however the unwind
 264                 // handler data (aka LSDA) uses GCC-compatible encoding.
 265                 #[lang = "eh_personality"]
 266                 #[allow(nonstandard_style)]
 267                 unsafe extern "C" fn rust_eh_personality(exceptionRecord: *mut uw::EXCEPTION_RECORD,
 268                         establisherFrame: uw::LPVOID,
 269                         contextRecord: *mut uw::CONTEXT,
 270                         dispatcherContext: *mut uw::DISPATCHER_CONTEXT)
 271                         -> uw::EXCEPTION_DISPOSITION {
 272                     uw::_GCC_specific_handler(exceptionRecord,
 273                                              establisherFrame,
 274                                              contextRecord,
 275                                              dispatcherContext,
 276                                              rust_eh_personality_impl)
 277                 }
 278             } else {
 279                 // The personality routine for most of our targets.
 280                 #[lang = "eh_personality"]
 281                 unsafe extern "C" fn rust_eh_personality(version: c_int,
 282                         actions: uw::_Unwind_Action,
 283                         exception_class: uw::_Unwind_Exception_Class,
 284                         exception_object: *mut uw::_Unwind_Exception,
 285                         context: *mut uw::_Unwind_Context)
 286                         -> uw::_Unwind_Reason_Code {
 287                     rust_eh_personality_impl(version,
 288                                              actions,
 289                                              exception_class,
 290                                              exception_object,
 291                                              context)
 292                 }
 293             }
 294         }
 295     }
 296 }
 297
 298 unsafe fn find_eh_action(
 299     context: *mut uw::_Unwind_Context,
 300     foreign_exception: bool,
 301 ) -> Result<EHAction, ()> {
 302     let lsda = uw::_Unwind_GetLanguageSpecificData(context) as *const u8;
 303     let mut ip_before_instr: c_int = 0;
 304     let ip = uw::_Unwind_GetIPInfo(context, &mut ip_before_instr);
 305     let eh_context = EHContext {
 306         // The return address points 1 byte past the call instruction,
 307         // which could be in the next IP range in LSDA range table.
 308         ip: if ip_before_instr != 0 { ip } else { ip - 1 },
 309         func_start: uw::_Unwind_GetRegionStart(context),
 310         get_text_start: &|| uw::_Unwind_GetTextRelBase(context),
 311         get_data_start: &|| uw::_Unwind_GetDataRelBase(context),
 312     };
 313     eh::find_eh_action(lsda, &eh_context, foreign_exception)
 314 }
 315
 316 #[cfg(all(
 317     bootstrap,
 318     target_os = "windows",
 319     any(target_arch = "x86", target_arch = "x86_64"),
 320     target_env = "gnu"
 321 ))]
 322 #[lang = "eh_unwind_resume"]
 323 #[unwind(allowed)]
 324 unsafe extern "C" fn rust_eh_unwind_resume(panic_ctx: *mut u8) -> ! {
 325     uw::_Unwind_Resume(panic_ctx as *mut uw::_Unwind_Exception);
 326 }
 327
 328 // Frame unwind info registration
 329 //
 330 // Each module's image contains a frame unwind info section (usually
 331 // ".eh_frame").  When a module is loaded/unloaded into the process, the
 332 // unwinder must be informed about the location of this section in memory. The
 333 // methods of achieving that vary by the platform.  On some (e.g., Linux), the
 334 // unwinder can discover unwind info sections on its own (by dynamically
 335 // enumerating currently loaded modules via the dl_iterate_phdr() API and
 336 // finding their ".eh_frame" sections); Others, like Windows, require modules
 337 // to actively register their unwind info sections via unwinder API.
 338 //
 339 // This module defines two symbols which are referenced and called from
 340 // rsbegin.rs to register our information with the GCC runtime. The
 341 // implementation of stack unwinding is (for now) deferred to libgcc_eh, however
 342 // Rust crates use these Rust-specific entry points to avoid potential clashes
 343 // with any GCC runtime.
 344 #[cfg(all(target_os = "windows", target_arch = "x86", target_env = "gnu"))]
 345 pub mod eh_frame_registry {
 346     extern "C" {
 347         fn __register_frame_info(eh_frame_begin: *const u8, object: *mut u8);
 348         fn __deregister_frame_info(eh_frame_begin: *const u8, object: *mut u8);
 349     }
 350
 351     #[rustc_std_internal_symbol]
 352     pub unsafe extern "C" fn rust_eh_register_frames(eh_frame_begin: *const u8, object: *mut u8) {
 353         __register_frame_info(eh_frame_begin, object);
 354     }
 355
 356     #[rustc_std_internal_symbol]
 357     pub unsafe extern "C" fn rust_eh_unregister_frames(eh_frame_begin: *const u8, object: *mut u8) {
 358         __deregister_frame_info(eh_frame_begin, object);
 359     }
 360 }